Package wt.team
Class WTRoleHolder2
java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.team._WTRoleHolder2
wt.team.WTRoleHolder2
- All Implemented Interfaces:
Externalizable,Serializable,wt.fc._NetFactor,wt.fc._ObjectMappable,wt.fc._Persistable,NetFactor,ObjectMappable,Persistable,DisplayIdentification,RoleHolder2
- Direct Known Subclasses:
wt.inf.team._ContainerTeam,_OrgContainer,wt.team._Team,wt.team._WTActorRoleHolder2
@GenAsPersistable(superClass=WTObject.class,
interfaces=RoleHolder2.class,
versions=-1374807685178137324L,
properties=@GeneratedProperty(name="category",type=TeamCategory.class))
public abstract class WTRoleHolder2
extends wt.team._WTRoleHolder2
Supported API: true
Extendable: false
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddPool(Role role, ObjectReference poolMember) Add a role to principal (pool) mapping to the rolePoolMap.voidaddPrincipal(Role role, WTPrincipal principal) Add a role to principal assignment to the holder If the WTPrincipal is not enabled, this action will be ignored.voiddeletePoolTarget(Role role, ObjectReference poolMember) Remove role to principal (pool) assignment pair from the RolePoolMap
Supported API: truevoiddeletePrincipalTarget(Role role, WTPrincipal principal) Remove a role to principal assignment pair
Supported API: truevoiddeleteRole(Role role) Remove a role object from the RoleHolder
Supported API: trueAnswer a Vector of enabled WTPrincipalReference of all assignees in the RoleHolder
Supported API: truegetPoolTarget(Role role) Answer an enumeration of principal references (pool participants) assigned to role in the rolePoolMap
Supported API: truegetPrincipalTarget(Role role) Answer an enumeration of the enabled principal references assigned a role.getRoles()Answer an enumeration of roles in the rolePrincipalMap
Supported API: trueMethods inherited from class wt.fc.WTObject
getDisplayIdentifier, getDisplayIdentity, getDisplayType
-
Method Details
-
addPrincipal
Add a role to principal assignment to the holder If the WTPrincipal is not enabled, this action will be ignored.
Supported API: true- Parameters:
role- the Role object to add WTPrincipals toprincipal- the WTPrincipal object to be added to the Role- Throws:
WTException
-
getPrincipalTarget
Answer an enumeration of the enabled principal references assigned a role. The enumeration is a copy of the real enumeration to prevent accidental modification.
Supported API: true- Parameters:
role- the Role object used as search criteria in the retrieval of PrincipalReferences- Returns:
- Enumeration
- Throws:
WTException
-
deletePrincipalTarget
Remove a role to principal assignment pair
Supported API: true- Parameters:
role- the Role object used as search criteria in the removal of the WTPrincipalprincipal- the WTPrincipal object to be removed- Throws:
WTException
-
getRoles
Answer an enumeration of roles in the rolePrincipalMap
Supported API: true- Returns:
- Vector
- Throws:
WTException
-
deleteRole
Remove a role object from the RoleHolder
Supported API: true- Parameters:
role- the Role object to be removed- Throws:
WTException
-
addPool
Add a role to principal (pool) mapping to the rolePoolMap.
Supported API: true- Parameters:
role- the Role object to be added to the rolePrincipalMappoolMember- the object to be added to the rolePrincipalMap. The only objects allowed are Teams and WTPrincipals.- Throws:
WTException
-
getPoolTarget
Answer an enumeration of principal references (pool participants) assigned to role in the rolePoolMap
Supported API: true- Parameters:
role- the Role object used as search criteria in the retrieval of PrincipalReferences- Returns:
- Enumeration
- Throws:
WTException
-
deletePoolTarget
Remove role to principal (pool) assignment pair from the RolePoolMap
Supported API: true- Parameters:
role- the Role object used as search criteria in the removal of the WTPrincipal from the rolePrincipalMappoolMember- a reference to the object to be removed from the rolePrincipalMap- Throws:
WTException
-
getMembers
Answer a Vector of enabled WTPrincipalReference of all assignees in the RoleHolder
Supported API: true- Returns:
- Vector
- Throws:
WTException
-