wt.team
Interface RoleHolder2

All Known Subinterfaces:

ActorRoleHolder2, IndirectRoleHolder2

All Known Implementing Classes:

WTActorRoleHolder2, WTIndirectRoleHolder2, WTRoleHolder2

public interface RoleHolder2

RoleHolder is an interface for classes implementing role to principal mappings

Supported API: true

Extendable: false

Method Summary

void	addPool(Role role, ObjectReference poolMember) Add a role to principal or team (pool) mapping to the rolePoolMap.
void	addPrincipal(Role role, WTPrincipal principal) Add a role to principal mapping to the rolePrincipalMap.
void	deletePoolTarget(Role role, ObjectReference poolMember) Remove role to principal or team (pool) assignment pair from the RolePoolMa Supported API: false
void	deletePrincipalTarget(Role role, WTPrincipal principal) Remove role to principal assignment pair Supported API: false
void	deleteRole(Role role) Remove the role and all associated principals from the rolePrincipalMap Supported API: false
Enumeration	getPoolTarget(Role role) Answer an enumeration of principal references (pool participants) assigned to role in the rolePoolMap Supported API: false
Enumeration	getPrincipalTarget(Role role) Answer an enumeration of principal references assigned to role Supported API: true
Vector	getRoles() Answer an enumeration of roles in the rolePrincipalMap Supported API: false

Method Detail

addPrincipal

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

Add a role to principal mapping to the rolePrincipalMap.

Supported API: false

Parameters:

role - the Role object to be added to the rolePrincipalMap

principal - the WTPrincipal object to be added to the rolePrincipalMap

Throws:

WTException

getPrincipalTarget

public Enumeration getPrincipalTarget(Role role)
                               throws WTException

Answer an enumeration of principal references assigned to role

Supported API: true

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 role to principal assignment pair

Supported API: false

Parameters:

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

principal - the WTPrincipal object to be removed from the rolePrincipalMap

Throws:

WTException

getRoles

public Vector getRoles()
                throws WTException

Answer an enumeration of roles in the rolePrincipalMap

Supported API: false

Returns:

Vector

Throws:

WTException

deleteRole

public void deleteRole(Role role)
                throws WTException

Remove the role and all associated principals from the rolePrincipalMap

Supported API: false

Parameters:

role -

Throws:

WTException

addPool

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

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

Supported API: false

Parameters:

role - the Role object to be added to the rolePrincipalMap

poolMember - a reference to the object to be added to the rolePrincipalMap

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: false

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 or team (pool) assignment pair from the RolePoolMa

Supported API: false

Parameters:

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

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

Throws:

WTException