wt.inf.team
Interface ContainerTeamService

All Known Implementing Classes:

ContainerTeamServiceFwd, StandardContainerTeamService

public interface ContainerTeamService

Methods for manipulating ContainerTeams

Supported API: true

Extendable: false

Method Summary

ContainerTeamManaged	activate(ContainerTeamManaged container) activate/start the ContainerTeamManaged object Supported API: true
void	addGuestMember(ContainerTeam team, WTPrincipal principal) This method adds the principal to guest group.
void	addMember(ContainerTeam team, Role role, WTPrincipal principal) This method adds the user to the necessary groups in the containers that use the container team.
void	confirmParticipation(ContainerTeamManaged container, WTUser user) Given a WTContainer object and a WTUser, record the fact that the user has confirmed they will be participating in the container.
ContainerTeamReference	createContainerTeam(String name, OrgContainer orgContainer, String desc, TeamCategory category) Creates a new Container Team.
WTGroup	findContainerTeamGroup(ContainerTeamManaged container, String searchBase, String groupName) This method returns a group stored in the container team ldap hiearchy.
Enumeration	findContainerTeamGroups(ContainerTeamManaged container, String searchBase) This method returns groups stored in the container team ldap hiearchy.
QueryResult	findRolePrincipalMap(Role role, WTPrincipal principal, ContainerTeam containerTeam) Based on the input parameters, return a QueryResult of RolePrincipalMap objects Supported API: false
ContainerTeam	getContainerTeam(ContainerTeamManaged container) Returns the container team for the specified container.
QueryResult	getMembersOf(ContainerSpec spec, int membership_state) Returns the WTUsers that are members of the containers specified by the ContainerSpec.
ContainerTeamManaged	inactivate(ContainerTeamManaged container, ContainerTeamManagedState state) inactivate/suspend the ContainerTeamManaged object Supported API: true
void	recomputeMembership(ContainerTeamManaged container) Synchs the ContainerTeamMembership with the LDAP groups.
void	recomputeMembership(WTGroup group) Synchs the ContainerTeamMembership with the LDAP groups.
void	removeGuestMember(ContainerTeam team, WTPrincipal principal) This method removes the principal from the guest group.
void	removeMember(ContainerTeam team, Role role, WTPrincipal principal) This method removed the user from the necessary groups in the containers that use the container team.
void	removeRole(ContainerTeam team, Role role) This method removes the user participating in the role from the necessary groups in the containers that use the container team.
void	replaceUser(ContainerTeamReference teamReference, WTUser replacedUser, WTUser newUser, boolean reassign) Deprecated.
void	replaceUser(ContainerTeamReference teamReference, WTUser replacedUser, WTUser newUser, boolean reassign, boolean removed) Replace the user in all containers that use the container team.
WTContained	setDefaultAdHocAcl(ContainerTeamManaged container, WTContained contained) Supported API: false
AdHocControlled	setPrincipalAdHocAcl(ContainerTeamManaged container, AdHocControlled per, Vector perms, WTPrincipal principal) Set the ad-hoc access rights for a given user or group.
AdHocControlled	setRoleAdHocAcl(ContainerTeamManaged container, AdHocControlled per, Vector perms, String roleName) Set the ad-hoc access rights for a given role in the container's team.

Method Detail

confirmParticipation

public void confirmParticipation(ContainerTeamManaged container,
                                 WTUser user)
                          throws WTException

Given a WTContainer object and a WTUser, record the fact that the user has confirmed they will be participating in the container.

Supported API: false

Parameters:

container -

user - The user that is confirming participation in the project

Throws:

WTException

setDefaultAdHocAcl

public WTContained setDefaultAdHocAcl(ContainerTeamManaged container,
                                      WTContained contained)
                               throws WTException,
                                      ClassNotFoundException

Supported API: false

Parameters:

container -

contained -

Returns:

WTContained

Throws:

WTException

ClassNotFoundException

createContainerTeam

public ContainerTeamReference createContainerTeam(String name,
                                                  OrgContainer orgContainer,
                                                  String desc,
                                                  TeamCategory category)
                                           throws WTException

Creates a new Container Team.

Supported API: true

Parameters:

name - The name of the container team.

orgContainer - The OrgContainer where the container is being created.

desc - A description of the container team.

category - Enumerated TeamCategory value.

Returns:

ContainerTeamReference

Throws:

WTException

addMember

public void addMember(ContainerTeam team,
                      Role role,
                      WTPrincipal principal)
               throws WTException

This method adds the user to the necessary groups in the containers that use the container team.

Supported API: true

Parameters:

team - The team where the participant should be added to the specified role.

role - The role where the participant will be added as a team member.

principal - The principal to be added to the role in the team.

Throws:

WTException

removeMember

public void removeMember(ContainerTeam team,
                         Role role,
                         WTPrincipal principal)
                  throws WTException

This method removed the user from the necessary groups in the containers that use the container team.

Supported API: true

Parameters:

team - The team where the participant should be removed from the specified role.

role - The role where the participant will be removed as a team member.

principal - The principal to be removed from the role in the team.

Throws:

WTException

removeRole

public void removeRole(ContainerTeam team,
                       Role role)
                throws WTException

This method removes the user participating in the role from the necessary groups in the containers that use the container team.

Supported API: true

Parameters:

team - The team where the role and should be removed. Participants who do not belong to additional roles in the team will be removed completely from the container team.

role - The role that should be removed from the team.

Throws:

WTException

replaceUser

public void replaceUser(ContainerTeamReference teamReference,
                        WTUser replacedUser,
                        WTUser newUser,
                        boolean reassign)
                 throws WTException

Deprecated.

Replace the user in all containers that use the container team.

Supported API: false

Parameters:

teamReference - A reference to the ContainerTeam where the user should be replaced.

replacedUser - The user being replaced.

newUser - The user taking the place of the replaced user.

reassign - A flag that indicates whether or not ad hoc acls and object subscriptions should be assigned to the new user.

Throws:

WTException

recomputeMembership

public void recomputeMembership(ContainerTeamManaged container)
                         throws WTException

Synchs the ContainerTeamMembership with the LDAP groups.

Supported API: true

Parameters:

container - The container that should be synched with the team.

Throws:

WTException

recomputeMembership

public void recomputeMembership(WTGroup group)
                         throws WTException

Synchs the ContainerTeamMembership with the LDAP groups.

Supported API: true

Parameters:

group -

Throws:

WTException

inactivate

public ContainerTeamManaged inactivate(ContainerTeamManaged container,
                                       ContainerTeamManagedState state)
                                throws WTException

inactivate/suspend the ContainerTeamManaged object

Supported API: true

Parameters:

container - the containerTeamManaged object to be inactiviated/suspended

state - the ContainerTeamManagedState that the inactivated container should be set to

Returns:

ContainerTeamManaged

Throws:

WTException

activate

public ContainerTeamManaged activate(ContainerTeamManaged container)
                              throws WTException

activate/start the ContainerTeamManaged object

Supported API: true

Parameters:

container - the ContainerTeamManaged object to be activated/started

Returns:

ContainerTeamManaged

Throws:

WTException

findRolePrincipalMap

public QueryResult findRolePrincipalMap(Role role,
                                        WTPrincipal principal,
                                        ContainerTeam containerTeam)
                                 throws WTException

Based on the input parameters, return a QueryResult of RolePrincipalMap objects

Supported API: false

Parameters:

role -

principal -

containerTeam -

Returns:

QueryResult

Throws:

WTException

findContainerTeamGroups

public Enumeration findContainerTeamGroups(ContainerTeamManaged container,
                                           String searchBase)
                                    throws WTException

This method returns groups stored in the container team ldap hiearchy. The search base indicates the node to search in the LDAP hiearchy. Node: ContainerTeamHelper.MEMBERSHIP_GROUPS Groups that will be found in node: ContainerTeamHelper.MY_PAGE_QUERYABLE ContainerTeamHelper.INVITED ContainerTeamHelper.USERS Node: ContainerTeamHelper.OTHER_GROUPS Groups that will be found in node: ContainerTeamHelper.GUEST ContainerTeamHelper.CONFIRMED Node: ContainerTeamHelper.ROLE_GROUPS Groups that will be found in node: Any group created from a role Node: ContainerTeamHelper.ORG_GROUPS Groups that will be found in node: Any group created from a role. Node: ContainerTeamHelper.ACCESS_GROUPS All groups found under the OTHER_GROUPS, ROLE_GROUPS and ORG_GROUPS nodes.

Supported API: false

Parameters:

container -

searchBase -

Returns:

Enumeration

Throws:

WTException

getContainerTeam

public ContainerTeam getContainerTeam(ContainerTeamManaged container)
                               throws WTException

Returns the container team for the specified container.

Supported API: true

Parameters:

container - The container of interest.

Returns:

ContainerTeam

Throws:

WTException

findContainerTeamGroup

public WTGroup findContainerTeamGroup(ContainerTeamManaged container,
                                      String searchBase,
                                      String groupName)
                               throws WTException

This method returns a group stored in the container team ldap hiearchy. The search base indicates the node to search in the LDAP hiearchy. The groupName is the name of the group you want to find. Valid search bases are as follows: Node: ContainerTeamHelper.MEMBERSHIP_GROUPS Groups found in node: ContainerTeamHelper.MY_PAGE_QUERYABLE ContainerTeamHelper.INVITED ContainerTeamHelper.USERS Node: ContainerTeamHelper.OTHER_GROUPS Groups found in node: ContainerTeamHelper.GUEST ContainerTeamHelper.CONFIRMED Node: ContainerTeamHelper.ROLE_GROUPS Groups found in node: Any group created from a role Node: ContainerTeamHelper.ORG_GROUPS Groups found in node: Any group created from a role.

Supported API: false

Parameters:

container -

searchBase -

groupName -

Returns:

WTGroup

Throws:

WTException

getMembersOf

public QueryResult getMembersOf(ContainerSpec spec,
                                int membership_state)
                         throws WTException

Returns the WTUsers that are members of the containers specified by the ContainerSpec.

Supported API: false

Parameters:

spec - Defines the set of containers to search in

membership_state - The membership state of the users that are returned. This is one of the membership state constants defined in ContainerSpec.

Returns:

QueryResult

Throws:

WTException

See Also:

ContainerSpec

addGuestMember

public void addGuestMember(ContainerTeam team,
                           WTPrincipal principal)
                    throws WTException

This method adds the principal to guest group.

Supported API: true

Parameters:

team - The team where the participant should be added to the specified role.

principal - The principal to be added to the role in the team.

Throws:

WTException

removeGuestMember

public void removeGuestMember(ContainerTeam team,
                              WTPrincipal principal)
                       throws WTException

This method removes the principal from the guest group.

Supported API: true

Parameters:

team - The team where the participant should be removed from the specified role.

principal - The principal to be removed from the role in the team.

Throws:

WTException

replaceUser

public void replaceUser(ContainerTeamReference teamReference,
                        WTUser replacedUser,
                        WTUser newUser,
                        boolean reassign,
                        boolean removed)
                 throws WTException

Replace the user in all containers that use the container team.

Supported API: true

Parameters:

teamReference - A reference to the ContainerTeam where the user should be replaced.

replacedUser - The user being replaced.

newUser - The user taking the place of the replaced user.

reassign - A flag that indicates whether or not ad hoc acls and object subscriptions should be assigned to the new user.

removed - This should be true if this was called as a result of the user being removed from the container. This boolean is needed to determine the message to display if the user cannot be removed due to checked out objects.

Throws:

WTException

setRoleAdHocAcl

public AdHocControlled setRoleAdHocAcl(ContainerTeamManaged container,
                                       AdHocControlled per,
                                       Vector perms,
                                       String roleName)
                                throws WTException

Set the ad-hoc access rights for a given role in the container's team. To remove all the ad-hoc access rights granted by the ProjectLink access ui or by this method previously, pass it an empty Vector of permissions. The object is returned after is has been saved.

Supported API: true

Parameters:

container - The Container for which the object is located in and for which to get the role from.

per - The object to set access on.

perms - a list of wt.access.AccessPermissions to grant to the role. If MODIFY is specified, a READ permission will be implicitly added as well. If the list is empty, all permissions will be removed for the role.

roleName - The role name that is used to find the container's role. Example, for out-of-the box roles, pass is all upper-case forms of the role name in english: "MANUFACTURER". For custom roles, pass in the string exactly as entered in the modify team ui: "my Custom Role".

Returns:

AdHocControlled

Throws:

WTException

setPrincipalAdHocAcl

public AdHocControlled setPrincipalAdHocAcl(ContainerTeamManaged container,
                                            AdHocControlled per,
                                            Vector perms,
                                            WTPrincipal principal)
                                     throws WTException

Set the ad-hoc access rights for a given user or group. To remove all the ad-hoc access rights granted by the ProjectLink access ui or by this method previously, pass it an empty Vector of permissions. The object is returned after is has been saved.

Supported API: true

Parameters:

container - The Container for which the object is located in and for which to get the role from.

per - The object to set access on.

perms - a list of wt.access.AccessPermissions to grant to the role. If MODIFY is specified, a READ permission will be implicitly added as well. If the list is empty, all permissions will be removed for the role.

principal - The user or group that is getting the new access level.

Returns:

AdHocControlled

Throws:

WTException