wt.team
Class WTRoleHolder2

java.lang.Object
  wt.fc.WTObject
      wt.team.WTRoleHolder2

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable, Persistable, DisplayIdentification, RoleHolder2

Direct Known Subclasses:

ContainerTeam, OrgContainer, WTActorRoleHolder2

public abstract class WTRoleHolder2
extends WTObject
implements RoleHolder2, Externalizable

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

void	addPool(Role role, ObjectReference poolMember) Add a role to principal (pool) mapping to the rolePoolMap.
void	addPrincipal(Role role, WTPrincipal principal) Add a role to principal assignment to the holder If the WTPrincipal is not enabled, this action will be ignored.
void	deletePoolTarget(Role role, ObjectReference poolMember) Remove role to principal (pool) assignment pair from the RolePoolMap Supported API: true
void	deletePrincipalTarget(Role role, WTPrincipal principal) Remove a role to principal assignment pair Supported API: true
void	deleteRole(Role role) Remove a role object from the RoleHolder Supported API: true
Vector	getMembers() Answer a Vector of enabled WTPrincipalReference of all assignees in the RoleHolder Supported API: true
Enumeration	getPoolTarget(Role role) Answer an enumeration of principal references (pool participants) assigned to role in the rolePoolMap Supported API: true
Enumeration	getPrincipalTarget(Role role) Answer an enumeration of the enabled principal references assigned a role.
Vector	getRoles() Answer an enumeration of roles in the rolePrincipalMap Supported API: true

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

addPrincipal

public void addPrincipal(Role role,
                         WTPrincipal principal)
                  throws WTException

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 to

principal - the WTPrincipal object to be added to the Role

Throws:

WTException

getPrincipalTarget

public Enumeration getPrincipalTarget(Role role)
                               throws WTException

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

Specified by:

getPrincipalTarget in interface RoleHolder2

Parameters:

role - the Role object used as search criteria in the retrieval of PrincipalReferences

Returns:

Enumeration

Throws:

WTException

deletePrincipalTarget

public void deletePrincipalTarget(Role role,
                                  WTPrincipal principal)
                           throws WTException

Remove a role to principal assignment pair

Supported API: true

Parameters:

role - the Role object used as search criteria in the removal of the WTPrincipal

principal - the WTPrincipal object to be removed

Throws:

WTException

getRoles

public Vector getRoles()
                throws WTException

Answer an enumeration of roles in the rolePrincipalMap

Supported API: true

Returns:

Vector

Throws:

WTException

deleteRole

public void deleteRole(Role role)
                throws WTException

Remove a role object from the RoleHolder

Supported API: true

Parameters:

role - the Role object to be removed

Throws:

WTException

addPool

public void addPool(Role role,
                    ObjectReference poolMember)
             throws WTException

Add a role to principal (pool) mapping to the rolePoolMap.

Supported API: true

Parameters:

role - the Role object to be added to the rolePrincipalMap

poolMember - the object to be added to the rolePrincipalMap. The only objects allowed are Teams and WTPrincipals.

Throws:

WTException

getPoolTarget

public Enumeration getPoolTarget(Role role)
                          throws WTException

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

public void deletePoolTarget(Role role,
                             ObjectReference poolMember)
                      throws WTException

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 rolePrincipalMap

poolMember - a reference to the object to be removed from the rolePrincipalMap

Throws:

WTException

getMembers

public Vector getMembers()
                  throws WTException

Answer a Vector of enabled WTPrincipalReference of all assignees in the RoleHolder

Supported API: true

Returns:

Vector

Throws:

WTException