StandardTeamService (WNC.X-05.0.0.00.73)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

wt.team
Class StandardTeamService

java.lang.Object
  wt.services.StandardManager
      wt.team.StandardTeamService

All Implemented Interfaces:: Manager, NetFactor, Serializable, TeamService, TeamServiceSvr

public class StandardTeamService
extends StandardManager
implements TeamServiceSvr, TeamService, Serializable

Standard implementation of the team service interfaces.

Use the newStandardTeamService static factory method(s), not the StandardTeamService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:: Serialized Form

Nested Class Summary
`(package private) static class`	`StandardTeamService.TeamTemplateFlusher`

Field Summary
`private static boolean`	`ADD_LC_ROLES_IN_CREATE`
`private static boolean`	`ALLOW_RERESOLUTION_LC_ROLES`
`private static boolean`	`BYPASS_DELETE_EVENT_DISPATCH`
`private static String`	`CLASSNAME`
`private static String`	`deleteRPMSQL`
`private static boolean`	`ENABLED_ONLY`
`private static Object`	`IGNORE_DELETE_KEY`
`private static String`	`RESOURCE`
`static String`	`RETEAM_WITHOUT_MODIFYING`
`private static SequencePool`	`sequencePool`
`private static String`	`SERVICE_NAME`
`static Object`	`TEAM`
`private static String`	`teamKey`
`private static Object`	`UNDO_CHECKOUT_KEY`
`private static boolean`	`VERBOSE`

Fields inherited from class wt.services.StandardManager

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Constructor Summary
`StandardTeamService()`

Method Summary
`void`	`addLCRoles(PhaseTemplate phaseTemplate, LifeCycleManaged object)` Deprecated.
`void`	`addRoleActorRoleMap(Role role, ActorRole actor, WTActorRoleHolder2 roleHolder)` Add a role to actor role assignment to the roleholder Supported API: false
`void`	`addRolePoolMap(Role role, WTObject pool, WTRoleHolder2 roleHolder)` Add a role to pooll assignment to the roleholder If the WTPrincinpal is not enabled, this action will be ignored.
`void`	`addRolePrincipalMap(Role role, WTPrincipal principal, WTRoleHolder2 roleHolder)` Add a role to principal assignment to the roleholder If the WTPrincinpal is not enabled, this action will be ignored.
`void`	`addRoleRoleMap(Role leftRole, Role rightRole, WTIndirectRoleHolder2 roleHolder)` Add a role to role assignment to the roleholder Supported API: false
`private Hashtable`	`addToHash(Hashtable hash, Role role, WTPrincipalReference pRef)`
`private void`	`addToMap(Map map, Role role, Object object)`
`void`	`augmentRoles(LifeCycleManaged object, TeamReference team)` Given a LifeCycleManaged object and a TeamReference, change the role participants to reflect those in the RoleHolder2 and dynamically update the participants of all Workflow Processes associated to the TeamReference.
`private CompositeWhereExpression`	`buildRemoveMembersWhereClause(Map ending, Map starting, CompositeWhereExpression whereExpression)`
`private Map`	`calculateNewMembers(Map finalMap, Map startingMap)`
`private static void`	`changeAdministrativeDomain(AdminDomainRef d_ref, TeamReference teamRef)`
`private Map`	`cloneMap(Map original)` Clones each list in the map
`Team`	`copyTeam(Team team, String copyName, AdminDomainRef domain, boolean persist)` Produces a copy of the Team object with the name passed as argument.
`TeamTemplate`	`copyTeamTemplate(TeamTemplate aTeamTemplate, String copyName, String folderLocation, boolean persist)` Produces a copy of the TeamTemplate object with the name passed as argument.
`TeamTemplate`	`copyTeamTemplate(WTContainerRef containerRef, TeamTemplate aTeamTemplate, String copyName, String folderLocation, boolean persist)` Produces a copy of the TeamTemplate object with the name passed as argument.
`private RoleActorRoleMap`	`createRoleActorRoleMap(Role role, ActorRole actor, WTActorRoleHolder2 roleHolder)`
`private void`	`createRoleActorRoleMaps(WTCollection collection, WTActorRoleHolder2 roleHolder, Map map)`
`private RolePrincipalMap`	`createRolePrincipalMap(Role role, WTPrincipalReference principalRef, WTRoleHolder2 roleHolder)`
`private RolePrincipalMap`	`createRolePrincipalMap(Role role, WTPrincipal principal, WTRoleHolder2 roleHolder)`
`private WTRoleHolder2`	`createRolePrincipalMaps(WTCollection collection, WTRoleHolder2 roleHolder, Map map)`
`TeamReference`	`createTeam(TeamTemplateReference teamTemplateReference, String teamName, String location, Persistable object)` Deprecated. @R7.0. Use createTeam(WTRoleHolder2, name, object) instead.
`TeamReference`	`createTeam(WTRoleHolder2 roleHolder, String teamName, Persistable object)` Creates a new Team based off the roleholder.
`private Team`	`createTeam(WTRoleHolder2 roleHolder, String teamName, Persistable object, boolean persist)`
`List`	`createTeams(Collection collection, WTKeyedMap phaseTemplates)` Creates a new Team based off the roleholder.
`WTList`	`createTeams(WTList objects, List names, WTRoleHolder2 roleHolder)` This api allows multiple teams to be created at one time for different objects.
`TeamTemplateReference`	`createTeamTemplate(String teamTemplateName, String location, String description, TeamCategory category, boolean enabled)` Creates a new TeamTemplate.
`TeamTemplateReference`	`createTeamTemplate(WTContainerRef containerRef, String teamTemplateName, String location, String description, TeamCategory category, boolean enabled)` Creates a new Team based off the Team Template.
`void`	`deleteNonSharedTeams(WTCollection collection)`
`void`	`deleteRole(Role role, WTRoleHolder2 roleHolder)` Remove all occurances of a Role object from the role holde Supported API: false
`void`	`deleteRoleActorRoleMap(Role role, ActorRole actor, WTActorRoleHolder2 roleHolder)` Remove a role to actor role assignment from the roleholder.
`void`	`deleteRolePoolMap(Role role, WTObject pool, WTRoleHolder2 roleHolder)` Remove a role to pool assignment from the roleholder Supported API: false
`void`	`deleteRolePrincipalMap(Role role, WTPrincipal principal, WTRoleHolder2 roleHolder)` Remove a role to principal assignment from the roleholder Supported API: false
`private static void`	`deleteRolePrincipalMaps(Team team)`
`private void`	`deleteRolePrincipalMaps(WTPrincipal principal)`
`void`	`deleteRoleRoleMap(Role leftRole, Role rightRole, WTIndirectRoleHolder2 roleHolder)` Remove a role to role assignment from the roleholder Supported API: false
`private void`	`deleteTeams(Set set, QueryResult results)`
`protected void`	`dispatchVetoableEvent(String eventType, TeamManaged object)` Dispatches a TeamServiceEvent that includes the event type and target (i.e., TeamManaged object).
`TeamManaged`	`doReteam(TeamManaged object, TeamTemplateReference teamTempRef)` Associate the object with a new team Supported API: false
`HashMap`	`findAllParticipantsByRole(WTRoleHolder2 roleholder)` This API returns a HashMap of all the participants of the role holder.
`Vector`	`findCandidateTeamDistributionLists()` Answer a vector of teamDistributionList references that are enabled Supported API: false
`Vector`	`findCandidateTeamDistributionLists(AdminDomainRef domainRef)` Answer a vector of teamDistributionList references that are enabled.
`Vector`	`findCandidateTeamDistributionLists(WTContainerRef containerRef)` Answer a vector of teamDistributionList references that are enabled Supported API: false
`Vector`	`findCandidateTeamDistributionLists(WTContainerRef containerRef, AdminDomainRef domainRef)` Answer a vector of teamDistributionList references that are enabled.
`Vector`	`findCandidateTeams()` Deprecated. @ R7.0.
`Vector`	`findCandidateTeams(AdminDomainRef adminDomainRef)` Deprecated. @R7.0.
`Vector`	`findCandidateTeamTemplates()` Answer a vector of teamTemplate references that the team managed object can be assigned to Supported API: false
`Vector`	`findCandidateTeamTemplates(AdminDomainRef domainRef)` Answer a vector of teamTemplate references that the team managed object can be assigned to.
`Vector`	`findCandidateTeamTemplates(WTContainerRef containerRef)` Answer a vector of teamTemplate references that the team managed object can be assigned to Supported API: false
`Vector`	`findCandidateTeamTemplates(WTContainerRef containerRef, AdminDomainRef domainRef)` Answer a vector of teamTemplate references that the team managed object can be assigned to Supported API: false
`private Vector`	`findEnabledTeamDistributionListsByDomain(WTContainerRef containerRef, AdministrativeDomain aDomain)`
`private Vector`	`findEnabledTeamsByDomain(AdministrativeDomain aDomain)` find methods *
`private Vector`	`findEnabledTeamTemplatesByDomain(WTContainerRef containerRef, AdministrativeDomain aDomain)`
`private Map`	`findObjectsTeams(WTList list)` This API finds all the teams associated with the objects in a collection and stores them.
`QueryResult`	`findRoleActorRoleMap(Role role, ActorRole actor, WTRoleHolder2 roleHolder)` Based on the input parameters, return a QueryResult of RoleActorRoleMap objects Supported API: false
`QueryResult`	`findRolePoolMap(Role role, WTObject pool, WTRoleHolder2 roleHolder)` Based on the input parameters, return a QueryResult of RolePoolMap objects Supported API: false
`QueryResult`	`findRolePrincipalMap(Role role, WTPrincipal principal, WTRoleHolder2 roleHolder)` Based on the input parameters, return a QueryResult of RolePrincipalMap objects Supported API: false
`private QueryResult`	`findRolePrincipalMap(Role role, WTPrincipal principal, WTRoleHolder2 roleHolder, boolean returnDisabled)` Based on the input parameters, return a QueryResult of RolePrincipalMap objects Supported API: false
`QueryResult`	`findRoleRoleMap(Role leftRole, Role rightRole, WTRoleHolder2 roleHolder)` Based on the input parameters, return a QueryResult of RoleRoleMap objects Supported API: false
`Vector`	`findRoles(WTRoleHolder2 roleHolder)` Return an enumeration of all roles in the WTRoleHolder2 Supported API: false
`Vector`	`findTeams()` Deprecated. @R.70.
`Vector`	`findTeams(AdminDomainRef adminDomainRef)` Deprecated. @R.70.
`Vector`	`findTeams(AdminDomainRef adminDomainRef, String teamName)` Deprecated. @R.70
`private Vector`	`findTeamsByDomain(AdministrativeDomain aDomain)`
`Vector`	`findTeamTemplates()` Answer a vector of TeamTemplateReferences for all team templates that match the input parameters, including the disabled ones Supported API: false
`Vector`	`findTeamTemplates(WTContainerRef containerRef)` Answer a vector of TeamTemplateReferences for all team templates that match the input parameters, including the disabled ones Supported API: false
`private static Enumeration`	`findWorkflowTeams(WTUser wtuser, WTContainer container)`
`String`	`getConceptualClassname()` Deprecated.
`TeamTemplate`	`getEnabledTeamTemplate(WTContainerRef containerRef, String teamTemplateIdentity)` Given the name or the identity of a TeamTemplate, find the enabled TeamTemplate object.
`private String`	`getIdentity(TeamManaged p)`
`private Object`	`getIgnoreDelete()`
`private String`	`getKey(WTContainerRef ref, String templateName)`
`private Map`	`getMapOfTeams(WTCollection collection)`
`Vector`	`getMembers(RoleHolder2 roleHolder)` Answer a vector of WTPrincipalReference of all members of a team object (Team, TeamTemplate or DistributionList) Supported API: false
`private Map`	`getRolePrincipalMapsForTeams(Set set)`
`private String`	`getStringOfTeamDistributionListIdentities(QueryResult qr)`
`private String`	`getStringOfTeamIdentities(QueryResult qr)`
`private String`	`getStringOfTeamTemplateIdentities(QueryResult qr)`
`Team`	`getTeam(AdministrativeDomain adminDomain, String teamName)` Deprecated. @R.70.
`Team`	`getTeam(String name)` This API finds a team by the specified name.
`Team`	`getTeam(TeamManaged object)` Given a TeamManaged object, answer the assigned Team Supported API: false
`TeamDistributionList`	`getTeamDistributionList(AdministrativeDomain adminDomain, String teamDistributionListName)` Finds a team distribution list specified by the input parameters.
`TeamDistributionList`	`getTeamDistributionList(String teamDistributionListIdentity)` Given the name or the identity of a Team Distribution List identity, find the Team Distribution List object.
`TeamDistributionList`	`getTeamDistributionList(WTContainerRef containerRef, AdministrativeDomain adminDomain, String teamDistributionListName)` Returns the team distribution list based on the parameters passed in.
`TeamDistributionList`	`getTeamDistributionList(WTContainerRef containerRef, String teamDistributionListIdentity)` Given the name or the identity of a Team Distribution List identity, find the Team Distribution List object.
`Vector`	`getTeams()` Deprecated. @R.70.
`TeamTemplate`	`getTeamTemplate(AdministrativeDomain adminDomain, String teamTemplateName)` Returns the team template by the specified name in the administrative domain.
`TeamTemplate`	`getTeamTemplate(String teamTemplateIdentity)` Given the name or the identity of a TeamTemplate, find the TeamTemplate object.
`TeamTemplate`	`getTeamTemplate(TeamManaged object)` Given a TeamManaged object, answer the assigned TeamTemplate Supported API: false
`TeamTemplate`	`getTeamTemplate(WTContainerRef containerRef, AdministrativeDomain adminDomain, String teamTemplateName)` Finds a team template as specified by the input parameters.
`TeamTemplate`	`getTeamTemplate(WTContainerRef containerRef, String teamTemplateIdentity)` Given the name or the identity of a TeamTemplate, find the TeamTemplate object.
`Vector`	`getTeamTemplateNames()` Retrieve an unsorted Vector of TeamTemplate names as strings.
`Vector`	`getTeamTemplateNames(WTContainerRef containerRef)` Retrieve an unsorted Vector of TeamTemplate names as strings.
`Vector`	`getTeamTemplates()` Answer a vector of teamTemplate references for all team templates including the disabled ones Supported API: false
`Vector`	`getTeamTemplates(WTContainerRef containerRef)` Answer a vector of teamTemplate references for all team templates including the disabled ones Supported API: false
`private boolean`	`isCheckedOut(TeamManaged object)`
`private boolean`	`isWorkingCopy(TeamManaged object)` Miscellaneous Methods *
`static StandardTeamService`	`newStandardTeamService()` Default factory for the class.
`protected void`	`performStartupProcess()` Overrides the startup process specific to the team service to provide custom startup for event subscription.
`Map`	`populateRoleActorRoleMap(WTActorRoleHolder2 actorRoleHolder)` This API returns a Map of all the actor roles of the role holder2.
`Map`	`populateRolePrincipalHash(WTRoleHolder2 roleHolder)` This API returns a Map of all the participants of the role holder.
`private Map`	`populateRolePrincipalHash(WTRoleHolder2 roleHolder, boolean returnDisabled)` creates a role-principal mapping of roleholder membership
`private void`	`printResults(Map map)`
`protected void`	`processCleanupLinkEvent(WTRoleHolder2 target, BinaryLink link)`
`protected void`	`processLatestIterationChange(TeamManaged original, TeamManaged replacement)` Maintain the cookie information upon checkin, etc
`void`	`registerEvents(ManagerService manager)` Overrides the registration of all applicable lifecycle service events with the service manager.
`private Hashtable`	`removeFromHash(Hashtable hash, Role role, WTPrincipalReference pRef)`
`private void`	`removeFromMap(Map map, Role role, Object object)`
`private static void`	`removeSecuredPrincipals(Map map)` removeSecuredPrincipals - removes the principals the current session principal does not have access to.
`private void`	`replaceUser(ContainerTeamManaged container, WTUser replacedUser, WTUser newUser)`
`WTPrincipalReference`	`resolveActorRole(ActorRole actorRole, Persistable object)` Given an actorRole and an object, resolve the actor role to a principal Supported API: false
`private Map`	`resolveAllTeamMembers(WTRoleHolder2 roleHolder, Team team, Persistable object, PhaseTemplate phaseTemplate)`
`private Vector`	`resolveByAllPrincipals(Map map, Role role, PhaseTemplate phaseTemplate, Persistable object, TeamTemplate teamTemplate, Vector principals)`
`private void`	`resolveContainerTeamRoles(Map map, Persistable object)`
`List`	`resolveLCRoles(WTList list, WTKeyedMap phaseTemplates)` This API resolved the lifecycle roles for the current phase of the lifecycle.
`private void`	`resolvePhaseTemplateRoles(Map map, TeamTemplate teamTemplate, Persistable object, PhaseTemplate phaseTemplate)`
`private Map`	`resolveWTRoleHolder2Roles(WTRoleHolder2 roleHolder, Persistable object)`
`TeamManaged`	`reteam(TeamManaged object, TeamTemplateReference teamTemplateRef)` Associate a team managed object with a new team.
`void`	`setIgnoreDelete(Object obj)` Supported API: false
`TeamManaged`	`setTeam(TeamManaged object, String teamName, String domain)` Set the team of the TeamManaged object Supported API: false
`private TeamManaged`	`setTeam(TeamManaged object, Team aTeam)`
`private TeamManaged`	`setTeam(TeamManaged object, TeamReference teamRef)`
`TeamManaged`	`setTeamTemplate(TeamManaged object, String teamTemplateName, String domain)` Set the teamTemplate of the TeamManaged object Supported API: false
`private TeamManaged`	`setTeamTemplate(TeamManaged object, TeamTemplate aTeamTemplate)`
`TeamManaged`	`setTeamTemplate(WTContainerRef containerRef, TeamManaged object, String teamTemplateName, String domain)` Set the teamTemplate of the TeamManaged object Supported API: false
`private Vector`	`teamDistributionListQRtoTeamDistributionListRefVector(QueryResult aResultSet)`
`private Vector`	`teamQRtoTeamRefVector(QueryResult aResultSet)`
`private Vector`	`teamTemplateQRtoTeamTemplateRefVector(QueryResult aResultSet)`
`void`	`updateCache(WTRoleHolder2 copy, WTRoleHolder2 readOnly)` This API should be used internally by the team service only.
`private void`	`updateReadOnlyContainerTeam(ContainerTeam team, RolePrincipalMap rpm, Role role, boolean add)`
`private void`	`updateReadOnlyTeamTemplate(TeamTemplate teamTemplate, RoleActorRoleMap rarm, Role role, boolean add)`
`private void`	`updateReadOnlyTeamTemplate(TeamTemplate teamTemplate, RolePrincipalMap rpm, Role role, boolean add)`
`private void`	`validateIsLatestIteration(TeamManaged object, String action)`
`TeamManaged`	`validateReteam(TeamManaged object, TeamTemplateReference teamTempRef)` Perform pre-team validations Supported API: false
`Vector`	`whereUsed(TeamReference team)` Answer a Vector of TeamManaged objects Note: Any services that persist a TeamReference are individually responsible for making sure the Team doesn't disappear on them.
`Vector`	`whereUsed(TeamTemplateReference teamTemplate)` Answer a Vector of Team objects Note: Any services that persist a TeamTemplateReference are individually responsible for making sure the Team Template doesn't disappear on them.

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:: Constant Field Values

CLASSNAME

private static final String CLASSNAME

IGNORE_DELETE_KEY

private static final Object IGNORE_DELETE_KEY

TEAM

public static final Object TEAM

teamKey

private static final String teamKey

See Also:: Constant Field Values

RETEAM_WITHOUT_MODIFYING

public static final String RETEAM_WITHOUT_MODIFYING

See Also:: Constant Field Values

VERBOSE

private static final boolean VERBOSE

SERVICE_NAME

private static final String SERVICE_NAME

See Also:: Constant Field Values

ENABLED_ONLY

private static final boolean ENABLED_ONLY

ADD_LC_ROLES_IN_CREATE

private static final boolean ADD_LC_ROLES_IN_CREATE

BYPASS_DELETE_EVENT_DISPATCH

private static final boolean BYPASS_DELETE_EVENT_DISPATCH

ALLOW_RERESOLUTION_LC_ROLES

private static final boolean ALLOW_RERESOLUTION_LC_ROLES

sequencePool

private static final SequencePool sequencePool

UNDO_CHECKOUT_KEY

private static final Object UNDO_CHECKOUT_KEY

deleteRPMSQL

private static final String deleteRPMSQL

See Also:: Constant Field Values

Constructor Detail

StandardTeamService

public StandardTeamService()

Method Detail

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:: getConceptualClassname in interface NetFactor
Overrides:: getConceptualClassname in class StandardManager

Returns:: String

performStartupProcess

protected void performStartupProcess()
                              throws ManagerException

Overrides the startup process specific to the team service to provide custom startup for event subscription. During subscription an anonymous inner class adapter is created per subscription to handle each specific event of interest.

Supported API: false

Overrides:: performStartupProcess in class StandardManager

Throws:: ManagerException

registerEvents

public void registerEvents(ManagerService manager)

Overrides the registration of all applicable lifecycle service events with the service manager.

Supported API: false

Specified by:: registerEvents in interface Manager
Overrides:: registerEvents in class StandardManager

Parameters:: manager - the ManagerService object used to override the registration of applicable events with the service manager

dispatchVetoableEvent

protected void dispatchVetoableEvent(String eventType,
                                     TeamManaged object)
                              throws WTException,
                                     WTPropertyVetoException

Dispatches a TeamServiceEvent that includes the event type and target (i.e., TeamManaged object).

Supported API: false

Parameters:: eventType - The name of the PersistentManagerEvent type.; object - The target of the persistable operation.
Throws:: WTException; WTPropertyVetoException

newStandardTeamService

public static StandardTeamService newStandardTeamService()
                                                  throws WTException

Default factory for the class.

Supported API: false

Returns:: StandardTeamService
Throws:: WTException

doReteam

public TeamManaged doReteam(TeamManaged object,
                            TeamTemplateReference teamTempRef)
                     throws WTException,
                            TeamException

Associate the object with a new team

Supported API: false

Specified by:: doReteam in interface TeamServiceSvr

Parameters:: object - the TeamManaged object to be re-teamed; teamTempRef -
Returns:: TeamManaged
Throws:: WTException; TeamException

validateReteam

public TeamManaged validateReteam(TeamManaged object,
                                  TeamTemplateReference teamTempRef)
                           throws WTException,
                                  TeamException

Perform pre-team validations

Supported API: false

Specified by:: validateReteam in interface TeamServiceSvr

Parameters:: object - theTeamManaged object that should be re-teamed.; teamTempRef -
Returns:: TeamManaged
Throws:: WTException; TeamException

resolveActorRole

public WTPrincipalReference resolveActorRole(ActorRole actorRole,
                                             Persistable object)
                                      throws WTException

Given an actorRole and an object, resolve the actor role to a principal

Supported API: false

Specified by:: resolveActorRole in interface TeamServiceSvr

Parameters:: actorRole - the ActorRole to be resolved; object - the object that is used to lookup a principal for the ActorRole
Returns:: WTPrincipalReference
Throws:: WTException

createTeams

public List createTeams(Collection collection,
                        WTKeyedMap phaseTemplates)
                 throws WTException

Creates a new Team based off the roleholder. The out of the box roleholders are Team Template, Team and Container Team. A WTKeyedMap is returned with the objects as the key with the objects TeamReference as the value. This is used by the StandardLifeCycleService. This API should NOTbe used outside of the StandardLifeCycleService.

Supported API: false

Specified by:: createTeams in interface TeamServiceSvr

Parameters:: collection - A collection of a collection of objects that need a team. A new team will be created for each object in the collection. This sub collections should be a collection of Persistables.; phaseTemplates -
Returns:: List
Throws:: WTException

resolveLCRoles

public List resolveLCRoles(WTList list,
                           WTKeyedMap phaseTemplates)
                    throws WTException

This API resolved the lifecycle roles for the current phase of the lifecycle. This API should only be used by the StandardLifeCycleService.

Supported API: false

Specified by:: resolveLCRoles in interface TeamServiceSvr

Parameters:: list - This is a WTList of objects whoose team needs to be updated.; phaseTemplates - This is a map of the phaseTemplates to the objects in the list.
Returns:: List
Throws:: WTException

findCandidateTeamTemplates

public Vector findCandidateTeamTemplates()
                                  throws WTException,
                                         TeamException

Answer a vector of teamTemplate references that the team managed object can be assigned to

Supported API: false

Specified by:: findCandidateTeamTemplates in interface TeamService

Returns:: Vector
Throws:: WTException; TeamException

findCandidateTeamTemplates

public Vector findCandidateTeamTemplates(AdminDomainRef domainRef)
                                  throws WTException,
                                         TeamException

Answer a vector of teamTemplate references that the team managed object can be assigned to. This API should be used only by Windchill PDM. All other products should use findCandidateTeamTemplate(WTContainerRef containerRef, AdminDomainRef domainRef).

Supported API: false

Specified by:: findCandidateTeamTemplates in interface TeamService

Parameters:: domainRef - the domain to search for team templates
Returns:: Vector
Throws:: WTException; TeamException

getTeamTemplate

public TeamTemplate getTeamTemplate(TeamManaged object)
                             throws WTException,
                                    TeamException

Given a TeamManaged object, answer the assigned TeamTemplate

Supported API: false

Specified by:: getTeamTemplate in interface TeamService

Parameters:: object - the object whoose team template should be returned
Returns:: TeamTemplate
Throws:: WTException; TeamException

reteam

public TeamManaged reteam(TeamManaged object,
                          TeamTemplateReference teamTemplateRef)
                   throws WTException,
                          TeamException

Associate a team managed object with a new team.

Supported API: false

Specified by:: reteam in interface TeamService

Parameters:: object - the TeamManaged object that should be associated with a new team; teamTemplateRef - a reference to a team, a TeamTemplateReference of the Team Template that the object should be reassigned to.
Returns:: TeamManaged
Throws:: WTException; TeamException

getMembers

public Vector getMembers(RoleHolder2 roleHolder)
                  throws WTException

Answer a vector of WTPrincipalReference of all members of a team object (Team, TeamTemplate or DistributionList)

Supported API: false

Specified by:: getMembers in interface TeamService

Parameters:: roleHolder - the roleholder of interest
Returns:: Vector
Throws:: WTException

copyTeamTemplate

public TeamTemplate copyTeamTemplate(TeamTemplate aTeamTemplate,
                                     String copyName,
                                     String folderLocation,
                                     boolean persist)
                              throws WTException

Produces a copy of the TeamTemplate object with the name passed as argument. If the name argument is "null", the name of the copied TeamTemplate is prefixed with 'copy of'. If the folder location is not specified, the object will be created in the orginal TeamTemplate's folder location. If the persist parameter is set to True, the object will be persisted before it is returned. If the persist parameter is set to False, the role-principal and role-actor role mappings will not be copied. Note: The 'Copy Of' prefix is pulled from a Resource Bundle for localization purposes. Note: This API should be used for Windchill PDM only. ProjectLink and PDMLink should use copyTeamTemplate(WTContainerRer containerRef, TeamTemplate aTeamTemplate, String copyName, String folderLocation, boolean persist)

Supported API: false

Specified by:: copyTeamTemplate in interface TeamService

Parameters:: aTeamTemplate - the team template to copy; copyName - the name to assign to teh copy; folderLocation - the location to store the team template. if null, the location will be set to the same location as the team template to copy; persist - specifies whether or not to persist the team template that is returned
Returns:: TeamTemplate
Throws:: WTException

getTeamTemplate

public TeamTemplate getTeamTemplate(String teamTemplateIdentity)
                             throws WTException,
                                    TeamException

Given the name or the identity of a TeamTemplate, find the TeamTemplate object. If the identity of the object is passed in and the TeamTemplate exists, it should always be returned. If the name of the TeamTemplate is passed in and there is only one in the sytem by that name, it will be returned. If the name of the TeamTemplate is passed in, but there are multiples in the system (in different cabinets) by that name, an exception will be thrown.

Supported API: false

Specified by:: getTeamTemplate in interface TeamService

Parameters:: teamTemplateIdentity - a String that contains the identity of the TeamTemplate
Returns:: TeamTemplate
Throws:: WTException; TeamException

createTeam

public TeamReference createTeam(TeamTemplateReference teamTemplateReference,
                                String teamName,
                                String location,
                                Persistable object)
                         throws WTException

Deprecated. @R7.0. Use createTeam(WTRoleHolder2, name, object) instead.

Creates a new Team based off the Team Template.

Supported API: false

Specified by:: createTeam in interface TeamService

Parameters:: teamTemplateReference - The TeamTemplateReference from which the Team is created.; teamName - The name for the new Team.; location - the administrative domain where the team should be saved; object - the object assigned to the team which is used to resolve actor roles into the team
Returns:: TeamReference
Throws:: WTException

whereUsed

public Vector whereUsed(TeamReference team)
                 throws WTException,
                        TeamException

Answer a Vector of TeamManaged objects Note: Any services that persist a TeamReference are individually responsible for making sure the Team doesn't disappear on them. For example, see the Workflow Engine and Workflow Definer service. These services listen for the pre_delete of a Team object and perform their own 'whereUsed' lookup. If the Team object that is about to be deleted is used by that service, that service vetoes the exception.

Supported API: false

Specified by:: whereUsed in interface TeamService

Parameters:: team - the team of interest
Returns:: Vector
Throws:: WTException; TeamException

findCandidateTeams

public Vector findCandidateTeams()
                          throws WTException

Deprecated. @ R7.0.

Answer a vector of team references

Supported API: false

Specified by:: findCandidateTeams in interface TeamService

Returns:: Vector
Throws:: WTException

findCandidateTeams

public Vector findCandidateTeams(AdminDomainRef adminDomainRef)
                          throws WTException

Deprecated. @R7.0.

Answer a vector of team references

Supported API: false

Specified by:: findCandidateTeams in interface TeamService

Parameters:: adminDomainRef - the domain to search for teams
Returns:: Vector
Throws:: WTException

copyTeam

public Team copyTeam(Team team,
                     String copyName,
                     AdminDomainRef domain,
                     boolean persist)
              throws WTException

Produces a copy of the Team object with the name passed as argument. If the name argument is "null", the name of the copied Team is prefixed with 'copy of'. If the domain is not specified, the object will be created in the orginal Teams's domain. If the persist parameter is set to True, the object will be persisted before it is returned. If the persist parameter is set to false, the role-principal mappings are not copied. Note: The 'Copy Of' prefix is pulled from a Resource Bundle for localization purposes.

Supported API: false

Specified by:: copyTeam in interface TeamService

Parameters:: team - the team to copy; copyName - the name to assign to the copy; domain - the domain to assign to the team. if the domain is null, it stores it in the same location as the team to copy; persist - specifies whether or not to persist the returned team
Returns:: Team
Throws:: WTException

findTeams

public Vector findTeams(AdminDomainRef adminDomainRef,
                        String teamName)
                 throws WTException

Deprecated. @R.70

Answer a vector of TeamReferences for all teams that match the input parameters, including the disabled ones

Supported API: false

Specified by:: findTeams in interface TeamService

Parameters:: adminDomainRef - the administrative domain to search for teams; teamName - the name of the team of interest
Returns:: Vector
Throws:: WTException

findTeams

public Vector findTeams()
                 throws WTException

Deprecated. @R.70.

Answer a vector of TeamReferences for all teams that match the input parameters, including the disabled ones

Supported API: false

Specified by:: findTeams in interface TeamService

Returns:: Vector
Throws:: WTException

findTeams

public Vector findTeams(AdminDomainRef adminDomainRef)
                 throws WTException

Deprecated. @R.70.

Answer a vector of TeamReferences for all teams that match the input parameters, including the disabled ones

Supported API: false

Specified by:: findTeams in interface TeamService

Parameters:: adminDomainRef - the administrative domain to search for teams
Returns:: Vector
Throws:: WTException

addRolePrincipalMap

public void addRolePrincipalMap(Role role,
                                WTPrincipal principal,
                                WTRoleHolder2 roleHolder)
                         throws WTException

Add a role to principal assignment to the roleholder If the WTPrincinpal is not enabled, this action will be ignored.

Supported API: false

Specified by:: addRolePrincipalMap in interface TeamService

Parameters:: role - the role to add the principal to in the roleholder; principal - the principal to add to the role; roleHolder - the roleholder to add the role-principal mapping to
Throws:: WTException

addRoleActorRoleMap

public void addRoleActorRoleMap(Role role,
                                ActorRole actor,
                                WTActorRoleHolder2 roleHolder)
                         throws WTException

Add a role to actor role assignment to the roleholder

Supported API: false

Specified by:: addRoleActorRoleMap in interface TeamService

Parameters:: role - the role to add the actor role to in the actor roleholder; actor - the actor role to add to the role; roleHolder - the roleholder to add the role-actor role map to
Throws:: WTException

addRoleRoleMap

public void addRoleRoleMap(Role leftRole,
                           Role rightRole,
                           WTIndirectRoleHolder2 roleHolder)
                    throws WTException

Add a role to role assignment to the roleholder

Supported API: false

Specified by:: addRoleRoleMap in interface TeamService

Parameters:: leftRole - the role to add the rightrole to in the roleholder; rightRole - the role to add to the leftrole in the roleholder; roleHolder - the roleholder the role-role mapping should be added to
Throws:: WTException

addRolePoolMap

public void addRolePoolMap(Role role,
                           WTObject pool,
                           WTRoleHolder2 roleHolder)
                    throws WTException

Add a role to pooll assignment to the roleholder If the WTPrincinpal is not enabled, this action will be ignored.

Supported API: false

Specified by:: addRolePoolMap in interface TeamService

Parameters:: role - the role to add the pool to in the roleholder; pool - the pool (WTPrincipal or Team) to add to the roleholder; roleHolder - the roleholder to add the role-pool mapping to
Throws:: WTException

deleteRole

public void deleteRole(Role role,
                       WTRoleHolder2 roleHolder)
                throws WTException

Remove all occurances of a Role object from the role holde

Supported API: false

Specified by:: deleteRole in interface TeamService

Parameters:: role - the role to remove from the roleholder; roleHolder - the roleholder of interest
Throws:: WTException

findRolePrincipalMap

public QueryResult findRolePrincipalMap(Role role,
                                        WTPrincipal principal,
                                        WTRoleHolder2 roleHolder)
                                 throws WTException

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

Supported API: false

Specified by:: findRolePrincipalMap in interface TeamService

Parameters:: role - the role to use in the search; principal - the principal to use in the search; roleHolder - the roleholder to use in the search
Returns:: QueryResult
Throws:: WTException

deleteRolePrincipalMap

public void deleteRolePrincipalMap(Role role,
                                   WTPrincipal principal,
                                   WTRoleHolder2 roleHolder)
                            throws WTException

Remove a role to principal assignment from the roleholder

Supported API: false

Specified by:: deleteRolePrincipalMap in interface TeamService

Parameters:: role - the role to remove the principal from in the roleholder; principal - the principal to remove from the role in the roleholder; roleHolder - the roleholder of interest
Throws:: WTException

deleteRoleActorRoleMap

public void deleteRoleActorRoleMap(Role role,
                                   ActorRole actor,
                                   WTActorRoleHolder2 roleHolder)
                            throws WTException

Remove a role to actor role assignment from the roleholder.

Supported API: false

Specified by:: deleteRoleActorRoleMap in interface TeamService

Parameters:: role - the role to remove from the actor from in the roleholder; actor - the actor role to remove from the role in the roleholder; roleHolder - the roleholder of interest
Throws:: WTException

deleteRoleRoleMap

public void deleteRoleRoleMap(Role leftRole,
                              Role rightRole,
                              WTIndirectRoleHolder2 roleHolder)
                       throws WTException

Remove a role to role assignment from the roleholder

Supported API: false

Specified by:: deleteRoleRoleMap in interface TeamService

Parameters:: leftRole - the role to remove the right role from in the roleholder; rightRole - the role to remove from the left role in the roleholder; roleHolder - the roleholder of interest
Throws:: WTException

deleteRolePoolMap

public void deleteRolePoolMap(Role role,
                              WTObject pool,
                              WTRoleHolder2 roleHolder)
                       throws WTException

Remove a role to pool assignment from the roleholder

Supported API: false

Specified by:: deleteRolePoolMap in interface TeamService

Parameters:: role - the role to remove the pool from in the roleholder; pool - the pool to remove from the role in the roleholder; roleHolder - the roleholder of interest
Throws:: WTException

findRoleActorRoleMap

public QueryResult findRoleActorRoleMap(Role role,
                                        ActorRole actor,
                                        WTRoleHolder2 roleHolder)
                                 throws WTException

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

Supported API: false

Specified by:: findRoleActorRoleMap in interface TeamService

Parameters:: role - the role to use in the search; actor - the actor role to use in the search; roleHolder - the roleholder to use in the search
Returns:: QueryResult
Throws:: WTException

findRoleRoleMap

public QueryResult findRoleRoleMap(Role leftRole,
                                   Role rightRole,
                                   WTRoleHolder2 roleHolder)
                            throws WTException

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

Supported API: false

Specified by:: findRoleRoleMap in interface TeamService

Parameters:: leftRole - the left role to use in the search; rightRole - the right role to use in the search; roleHolder - the roleholder to use in the search
Returns:: QueryResult
Throws:: WTException

findRolePoolMap

public QueryResult findRolePoolMap(Role role,
                                   WTObject pool,
                                   WTRoleHolder2 roleHolder)
                            throws WTException

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

Supported API: false

Specified by:: findRolePoolMap in interface TeamService

Parameters:: role - the role to use in the search; pool - the pool to use in the search; roleHolder - the roleholder to use in the search
Returns:: QueryResult
Throws:: WTException

findRoles

public Vector findRoles(WTRoleHolder2 roleHolder)
                 throws WTException

Return an enumeration of all roles in the WTRoleHolder2

Supported API: false

Specified by:: findRoles in interface TeamService

Parameters:: roleHolder - the roleholder to use in the search
Returns:: Vector
Throws:: WTException

whereUsed

public Vector whereUsed(TeamTemplateReference teamTemplate)
                 throws WTException,
                        TeamException

Answer a Vector of Team objects Note: Any services that persist a TeamTemplateReference are individually responsible for making sure the Team Template doesn't disappear on them. For example, see the Workflow Engine and Workflow Definer service. These services listen for the pre_delete of a Team object and perform their own 'whereUsed' lookup. If the Team object that is about to be deleted is used by that service, that service vetoes the exception.

Supported API: false

Specified by:: whereUsed in interface TeamService

Parameters:: teamTemplate - the team template of interest
Returns:: Vector
Throws:: WTException; TeamException

addLCRoles

public void addLCRoles(PhaseTemplate phaseTemplate,
                       LifeCycleManaged object)
                throws TeamException,
                       WTException

Deprecated.

This method resolved the lifecycle roles into the team. This API should only be used by the Lifecycle Service.

Supported API: false

Specified by:: addLCRoles in interface TeamService

Parameters:: phaseTemplate - the PhaseTemplate containing the role-participant mappings for the lifecycle phase; object - the object used during role resolution
Throws:: TeamException; WTException

createTeamTemplate

public TeamTemplateReference createTeamTemplate(String teamTemplateName,
                                                String location,
                                                String description,
                                                TeamCategory category,
                                                boolean enabled)
                                         throws WTException

Creates a new TeamTemplate. This should only be used by Windchill PDM. Projects, Libraries and Products should use createTeamTemplate(WTContainerRef containerRef, String teamTemplateName, String location, String description, TeamCategory category, boolean enabled).

Supported API: false

Specified by:: createTeamTemplate in interface TeamService

Parameters:: teamTemplateName - the name to assign to the team template; location - the location where the team should be stored; description - the description to assign to the team template; category - the TeamCategory to assign to the team template; enabled - specifies whether or not the team template should be enabled
Returns:: TeamTemplateReference
Throws:: WTException

getTeamTemplate

public TeamTemplate getTeamTemplate(AdministrativeDomain adminDomain,
                                    String teamTemplateName)
                             throws WTException,
                                    TeamException

Returns the team template by the specified name in the administrative domain.

Supported API: false

Specified by:: getTeamTemplate in interface TeamService

Parameters:: adminDomain - the administrative domain to search for the team template; teamTemplateName - the name of the team template to search for
Returns:: TeamTemplate
Throws:: WTException; TeamException

getTeam

public Team getTeam(AdministrativeDomain adminDomain,
                    String teamName)
             throws WTException,
                    TeamException

Deprecated. @R.70.

Supported API: false

Specified by:: getTeam in interface TeamService

Parameters:: adminDomain - the administrative domain to search for teams; teamName - the name of the team to search for
Returns:: Team
Throws:: WTException; TeamException

getTeams

public Vector getTeams()
                throws WTException,
                       TeamException

Deprecated. @R.70.

Answer a vector of team references for all teams, including the disabled ones

Supported API: false

Specified by:: getTeams in interface TeamService

Returns:: Vector
Throws:: WTException; TeamException

getTeamDistributionList

public TeamDistributionList getTeamDistributionList(String teamDistributionListIdentity)
                                             throws WTException,
                                                    TeamException

Given the name or the identity of a Team Distribution List identity, find the Team Distribution List object. If the identity of the object is passed in and the TeamDistributionList exists, it should always be returned. If the name of the TeamDistribtuionList is passed in and there is only one in the sytem by that name, it will be returned. If the name of the TeamDistributionList is passed in, but there are multiples in the system (in different cabinets) by that name, an exception will be thrown.

Supported API: false

Specified by:: getTeamDistributionList in interface TeamService

Parameters:: teamDistributionListIdentity - a String that contains the identity of the Team
Returns:: TeamDistributionList
Throws:: WTException; TeamException

findCandidateTeamDistributionLists

public Vector findCandidateTeamDistributionLists()
                                          throws WTException,
                                                 TeamException

Answer a vector of teamDistributionList references that are enabled

Supported API: false

Specified by:: findCandidateTeamDistributionLists in interface TeamService

Returns:: Vector
Throws:: WTException; TeamException

findCandidateTeamDistributionLists

public Vector findCandidateTeamDistributionLists(AdminDomainRef domainRef)
                                          throws WTException,
                                                 TeamException

Answer a vector of teamDistributionList references that are enabled. This should be used in Windchill PDM only. All other products should use findCandidateTeamDistributionLists(WTContainerRef containerRef, AdminDomainRef domainRef)

Supported API: false

Specified by:: findCandidateTeamDistributionLists in interface TeamService

Parameters:: domainRef - the administrative domain to search in for team distribution lists
Returns:: Vector
Throws:: WTException; TeamException

getTeamDistributionList

public TeamDistributionList getTeamDistributionList(AdministrativeDomain adminDomain,
                                                    String teamDistributionListName)
                                             throws WTException,
                                                    TeamException

Finds a team distribution list specified by the input parameters.

Supported API: false

Specified by:: getTeamDistributionList in interface TeamService

Parameters:: adminDomain - the administrative domain to search for team distribution lists in; teamDistributionListName - the name of the team distribution list to search for
Returns:: TeamDistributionList
Throws:: WTException; TeamException

getTeamTemplateNames

public Vector getTeamTemplateNames()
                            throws WTException

Retrieve an unsorted Vector of TeamTemplate names as strings. The list includes all TeamTemplates including those which are no longer enabled.

Supported API: false

Specified by:: getTeamTemplateNames in interface TeamService

Returns:: Vector
Throws:: WTException

findTeamTemplates

public Vector findTeamTemplates()
                         throws WTException

Answer a vector of TeamTemplateReferences for all team templates that match the input parameters, including the disabled ones

Supported API: false

Specified by:: findTeamTemplates in interface TeamService

Returns:: Vector
Throws:: WTException

getTeam

public Team getTeam(TeamManaged object)
             throws WTException,
                    TeamException

Given a TeamManaged object, answer the assigned Team

Supported API: false

Specified by:: getTeam in interface TeamService

Parameters:: object - the TeamManaged object whoose team should be returned
Returns:: Team
Throws:: WTException; TeamException

setTeamTemplate

public TeamManaged setTeamTemplate(TeamManaged object,
                                   String teamTemplateName,
                                   String domain)
                            throws WTException,
                                   TeamException,
                                   WTPropertyVetoException

Set the teamTemplate of the TeamManaged object

Supported API: false

Specified by:: setTeamTemplate in interface TeamService

Parameters:: object - the TeamManaged object whose teamTemplate should be set; teamTemplateName - a String that contains the name of the teamTemplate to set on the TeamManaged object.; domain - a String that contain the AdministrativeDomain of the Team that should be set
Returns:: TeamManaged
Throws:: WTException; TeamException; WTPropertyVetoException

setTeam

public TeamManaged setTeam(TeamManaged object,
                           String teamName,
                           String domain)
                    throws WTException,
                           TeamException,
                           WTPropertyVetoException

Set the team of the TeamManaged object

Supported API: false

Specified by:: setTeam in interface TeamService

Parameters:: object - the TeamManaged object whose teamTemplate should be set; teamName - a String that contains the name of the team to set on the TeamManaged object.; domain - a String that contain the AdministrativeDomain of the Team that should be set
Returns:: TeamManaged
Throws:: WTException; TeamException; WTPropertyVetoException

getTeamTemplates

public Vector getTeamTemplates()
                        throws WTException,
                               TeamException

Answer a vector of teamTemplate references for all team templates including the disabled ones

Supported API: false

Specified by:: getTeamTemplates in interface TeamService

Returns:: Vector
Throws:: WTException; TeamException

setIgnoreDelete

public void setIgnoreDelete(Object obj)
                     throws WTException

Supported API: false

Specified by:: setIgnoreDelete in interface TeamService

Parameters:: obj -
Throws:: WTException

findCandidateTeamTemplates

public Vector findCandidateTeamTemplates(WTContainerRef containerRef)
                                  throws WTException,
                                         TeamException

Answer a vector of teamTemplate references that the team managed object can be assigned to

Supported API: false

Specified by:: findCandidateTeamTemplates in interface TeamService

Parameters:: containerRef - the container to search for team templates
Returns:: Vector
Throws:: WTException; TeamException

findCandidateTeamTemplates

public Vector findCandidateTeamTemplates(WTContainerRef containerRef,
                                         AdminDomainRef domainRef)
                                  throws WTException,
                                         TeamException

Answer a vector of teamTemplate references that the team managed object can be assigned to

Supported API: false

Specified by:: findCandidateTeamTemplates in interface TeamService

Parameters:: containerRef - the container to search for team templates; domainRef - the administrative domain to search for team templates
Returns:: Vector
Throws:: WTException; TeamException

copyTeamTemplate

public TeamTemplate copyTeamTemplate(WTContainerRef containerRef,
                                     TeamTemplate aTeamTemplate,
                                     String copyName,
                                     String folderLocation,
                                     boolean persist)
                              throws WTException

Produces a copy of the TeamTemplate object with the name passed as argument. If the name argument is "null", the name of the copied TeamTemplate is prefixed with 'copy of'. If the folder location is not specified, the object will be created in the orginal TeamTemplate's folder location. If the persist parameter is set to True, the object will be persisted before it is returned. If the parameter is set to False, the role-principal maps and role-actor role maps will not be copied. Note: The 'Copy Of' prefix is pulled from a Resource Bundle for localization purposes.

Supported API: false

Specified by:: copyTeamTemplate in interface TeamService

Parameters:: containerRef - the context where the team template should be stored; aTeamTemplate - the team template to copy; copyName - the name to assign to the copy; folderLocation - the folder location to assign to the copy. if null, the team template will be assigned to the same location as the team template to copy; persist - specifies whether or not to persist the copy
Returns:: TeamTemplate
Throws:: WTException

getTeamTemplate

public TeamTemplate getTeamTemplate(WTContainerRef containerRef,
                                    String teamTemplateIdentity)
                             throws WTException,
                                    TeamException

Specified by:: getTeamTemplate in interface TeamService

Parameters:: containerRef - the container to search for the team template; teamTemplateIdentity - a String that contains the identity of the TeamTemplate
Returns:: TeamTemplate
Throws:: WTException; TeamException

createTeam

public TeamReference createTeam(WTRoleHolder2 roleHolder,
                                String teamName,
                                Persistable object)
                         throws WTException

Creates a new Team based off the roleholder. The out of the box roleholders are Team Template, Team and Container Team.

Supported API: false

Specified by:: createTeam in interface TeamService

Parameters:: roleHolder - the roleholder from which the Team is created; teamName - the name to assign to the team; object - the object used to resolve actor roles into the team
Returns:: TeamReference
Throws:: WTException

createTeamTemplate

public TeamTemplateReference createTeamTemplate(WTContainerRef containerRef,
                                                String teamTemplateName,
                                                String location,
                                                String description,
                                                TeamCategory category,
                                                boolean enabled)
                                         throws WTException

Creates a new Team based off the Team Template.

Supported API: false

Specified by:: createTeamTemplate in interface TeamService

Parameters:: containerRef - the container the team template belongs to; teamTemplateName - the name to assign to the team template; location - the location of the team template; description - the description to assign to the team template; category - the TeamCategory to assign to the team template; enabled - specifies whether or not the team template should be enabled
Returns:: TeamTemplateReference
Throws:: WTException

getTeamTemplate

public TeamTemplate getTeamTemplate(WTContainerRef containerRef,
                                    AdministrativeDomain adminDomain,
                                    String teamTemplateName)
                             throws WTException,
                                    TeamException

Finds a team template as specified by the input parameters.

Supported API: false

Specified by:: getTeamTemplate in interface TeamService

Parameters:: containerRef - the container to search for team templates; adminDomain - the administrative domain to search for team templates; teamTemplateName - the name of the team template to search for
Returns:: TeamTemplate
Throws:: WTException; TeamException

getTeamDistributionList

public TeamDistributionList getTeamDistributionList(WTContainerRef containerRef,
                                                    String teamDistributionListIdentity)
                                             throws WTException,
                                                    TeamException

Specified by:: getTeamDistributionList in interface TeamService

Parameters:: containerRef - the container to search for team distribution lists; teamDistributionListIdentity - a String that contains the identity of the team distribution list
Returns:: TeamDistributionList
Throws:: WTException; TeamException

findCandidateTeamDistributionLists

public Vector findCandidateTeamDistributionLists(WTContainerRef containerRef)
                                          throws WTException,
                                                 TeamException

Answer a vector of teamDistributionList references that are enabled

Supported API: false

Specified by:: findCandidateTeamDistributionLists in interface TeamService

Parameters:: containerRef - the container to search for team distribution lists
Returns:: Vector
Throws:: WTException; TeamException

findCandidateTeamDistributionLists

public Vector findCandidateTeamDistributionLists(WTContainerRef containerRef,
                                                 AdminDomainRef domainRef)
                                          throws WTException,
                                                 TeamException

Answer a vector of teamDistributionList references that are enabled.

Supported API: false

Specified by:: findCandidateTeamDistributionLists in interface TeamService

Parameters:: containerRef - the container to search for team distribution lists; domainRef - the domain in the container to search for team distribution lists
Returns:: Vector
Throws:: WTException; TeamException

getTeamDistributionList

public TeamDistributionList getTeamDistributionList(WTContainerRef containerRef,
                                                    AdministrativeDomain adminDomain,
                                                    String teamDistributionListName)
                                             throws WTException,
                                                    TeamException

Returns the team distribution list based on the parameters passed in.

Supported API: false

Specified by:: getTeamDistributionList in interface TeamService

Parameters:: containerRef - the container to search for the team distribution list; adminDomain - the administrative domain to search for team distribution lists; teamDistributionListName - the name of the team distribution list to search for
Returns:: TeamDistributionList
Throws:: WTException; TeamException

getTeamTemplateNames

public Vector getTeamTemplateNames(WTContainerRef containerRef)
                            throws WTException

Retrieve an unsorted Vector of TeamTemplate names as strings. The list includes all TeamTemplates including those which are no longer enabled.

Supported API: false

Specified by:: getTeamTemplateNames in interface TeamService

Parameters:: containerRef - the container to search for team template names
Returns:: Vector
Throws:: WTException

findTeamTemplates

public Vector findTeamTemplates(WTContainerRef containerRef)
                         throws WTException

Answer a vector of TeamTemplateReferences for all team templates that match the input parameters, including the disabled ones

Supported API: false

Specified by:: findTeamTemplates in interface TeamService

Parameters:: containerRef - the container to search for team templates
Returns:: Vector
Throws:: WTException

getTeamTemplates

public Vector getTeamTemplates(WTContainerRef containerRef)
                        throws WTException,
                               TeamException

Answer a vector of teamTemplate references for all team templates including the disabled ones

Supported API: false

Specified by:: getTeamTemplates in interface TeamService

Parameters:: containerRef -
Returns:: Vector
Throws:: WTException; TeamException

setTeamTemplate

public TeamManaged setTeamTemplate(WTContainerRef containerRef,
                                   TeamManaged object,
                                   String teamTemplateName,
                                   String domain)
                            throws WTException,
                                   TeamException,
                                   WTPropertyVetoException

Set the teamTemplate of the TeamManaged object

Supported API: false

Specified by:: setTeamTemplate in interface TeamService

Parameters:: containerRef - the container to search for the team template to assign to the object; object - the TeamManaged object whose teamTemplate should be set; teamTemplateName - a String that contains the name of the teamTemplate to set on the TeamManaged object.; domain - a String that contain the AdministrativeDomain of the Team that should be set
Returns:: TeamManaged
Throws:: WTException; TeamException; WTPropertyVetoException

findAllParticipantsByRole

public HashMap findAllParticipantsByRole(WTRoleHolder2 roleholder)
                                  throws WTException

This API returns a HashMap of all the participants of the role holder. The hash map contains they roles as keys. The value of the key is a List containing the WTPrinicipalReferences assigned to the role.

Supported API: false

Specified by:: findAllParticipantsByRole in interface TeamService

Parameters:: roleholder - the roleholder of interest
Returns:: HashMap
Throws:: WTException

populateRolePrincipalHash

public Map populateRolePrincipalHash(WTRoleHolder2 roleHolder)
                              throws WTException

This API returns a Map of all the participants of the role holder. The map contains they roles as keys. The value of the key is a List containing the WTPrinicipalReferences assigned to the role. This should only be used by the team service.

Supported API: false

Specified by:: populateRolePrincipalHash in interface TeamService

Parameters:: roleHolder - the WTRoleHolder2 of interest
Returns:: Map
Throws:: WTException

populateRoleActorRoleMap

public Map populateRoleActorRoleMap(WTActorRoleHolder2 actorRoleHolder)
                             throws WTException

This API returns a Map of all the actor roles of the role holder2. The map contains they roles as keys. The value of the key is a List containing the WTPrinicipalReferences assigned to the role. This should be used by the team service only.

Supported API: false

Specified by:: populateRoleActorRoleMap in interface TeamService

Parameters:: actorRoleHolder - The WTActorRoleHolder2 of interest.
Returns:: Map
Throws:: WTException

createTeams

public WTList createTeams(WTList objects,
                          List names,
                          WTRoleHolder2 roleHolder)
                   throws WTException

This api allows multiple teams to be created at one time for different objects. It returns a WTList of the teams. The teams are added to the list in the same order as the objects they are created for.

Supported API: false

Specified by:: createTeams in interface TeamService

Parameters:: objects - a list of the objects to create teams for; names - the names of the teams - null is acceptable; roleHolder - the roleholder to use as a base for creating the team
Returns:: WTList
Throws:: WTException

updateCache

public void updateCache(WTRoleHolder2 copy,
                        WTRoleHolder2 readOnly)
                 throws WTException

This API should be used internally by the team service only.

Supported API: false

Specified by:: updateCache in interface TeamService

Parameters:: copy -; readOnly -
Throws:: WTException

augmentRoles

public void augmentRoles(LifeCycleManaged object,
                         TeamReference team)
                  throws WTException,
                         LifeCycleException

Given a LifeCycleManaged object and a TeamReference, change the role participants to reflect those in the RoleHolder2 and dynamically update the participants of all Workflow Processes associated to the TeamReference.

Supported API: false

Specified by:: augmentRoles in interface TeamService

Parameters:: object - the object associated to the team that needs to have it's membership updated; team - the team to apply to the object
Throws:: WTException; LifeCycleException

getTeam

public Team getTeam(String name)
             throws WTException

This API finds a team by the specified name. Since team names are not unique, this will return the first team found by the given name.

Supported API: false

Specified by:: getTeam in interface TeamService

Parameters:: name - the name of the team to search for
Returns:: Team
Throws:: WTException

getEnabledTeamTemplate

public TeamTemplate getEnabledTeamTemplate(WTContainerRef containerRef,
                                           String teamTemplateIdentity)
                                    throws WTException,
                                           TeamException

Given the name or the identity of a TeamTemplate, find the enabled TeamTemplate object. If the identity of the object is passed in and the TeamTemplate exists, it should always be returned. This query does a hierchical lookup of the objects and will find the first found in the hiearchy.

Supported API: false

Specified by:: getEnabledTeamTemplate in interface TeamService

Parameters:: containerRef - the container to search for enabled team templates; teamTemplateIdentity - a String that contains the identity of the TeamTemplate
Returns:: TeamTemplate
Throws:: WTException; TeamException

processLatestIterationChange

protected void processLatestIterationChange(TeamManaged original,
                                            TeamManaged replacement)
                                     throws WTException

Maintain the cookie information upon checkin, etc

Throws:: WTException

processCleanupLinkEvent

protected void processCleanupLinkEvent(WTRoleHolder2 target,
                                       BinaryLink link)
                                throws WTException

Throws:: WTException

isWorkingCopy

private boolean isWorkingCopy(TeamManaged object)
                       throws WTException

Miscellaneous Methods *

Throws:: WTException

isCheckedOut

private boolean isCheckedOut(TeamManaged object)
                      throws WTException

Throws:: WTException

validateIsLatestIteration

private void validateIsLatestIteration(TeamManaged object,
                                       String action)
                                throws WTException

Throws:: WTException

setTeam

private TeamManaged setTeam(TeamManaged object,
                            TeamReference teamRef)
                     throws WTException

Throws:: WTException

getIdentity

private String getIdentity(TeamManaged p)

findEnabledTeamsByDomain

private Vector findEnabledTeamsByDomain(AdministrativeDomain aDomain)
                                 throws TeamException

find methods *

Throws:: TeamException

findEnabledTeamDistributionListsByDomain

private Vector findEnabledTeamDistributionListsByDomain(WTContainerRef containerRef,
                                                        AdministrativeDomain aDomain)
                                                 throws TeamException

Throws:: TeamException

findEnabledTeamTemplatesByDomain

private Vector findEnabledTeamTemplatesByDomain(WTContainerRef containerRef,
                                                AdministrativeDomain aDomain)
                                         throws TeamException

Throws:: TeamException

findTeamsByDomain

private Vector findTeamsByDomain(AdministrativeDomain aDomain)
                          throws TeamException

Throws:: TeamException

teamQRtoTeamRefVector

private Vector teamQRtoTeamRefVector(QueryResult aResultSet)
                              throws WTException

Throws:: WTException

teamDistributionListQRtoTeamDistributionListRefVector

private Vector teamDistributionListQRtoTeamDistributionListRefVector(QueryResult aResultSet)
                                                              throws WTException

Throws:: WTException

teamTemplateQRtoTeamTemplateRefVector

private Vector teamTemplateQRtoTeamTemplateRefVector(QueryResult aResultSet)
                                              throws WTException

Throws:: WTException

getStringOfTeamTemplateIdentities

private String getStringOfTeamTemplateIdentities(QueryResult qr)
                                          throws WTException,
                                                 TeamException

Throws:: WTException; TeamException

getStringOfTeamIdentities

private String getStringOfTeamIdentities(QueryResult qr)
                                  throws WTException,
                                         TeamException

Throws:: WTException; TeamException

getStringOfTeamDistributionListIdentities

private String getStringOfTeamDistributionListIdentities(QueryResult qr)
                                                  throws WTException,
                                                         TeamException

Throws:: WTException; TeamException

setTeamTemplate

private TeamManaged setTeamTemplate(TeamManaged object,
                                    TeamTemplate aTeamTemplate)
                             throws WTException

Throws:: WTException

setTeam

private TeamManaged setTeam(TeamManaged object,
                            Team aTeam)
                     throws WTException

Throws:: WTException

getIgnoreDelete

private Object getIgnoreDelete()

createRolePrincipalMap

private RolePrincipalMap createRolePrincipalMap(Role role,
                                                WTPrincipal principal,
                                                WTRoleHolder2 roleHolder)
                                         throws WTException

Throws:: WTException

createRolePrincipalMap

private RolePrincipalMap createRolePrincipalMap(Role role,
                                                WTPrincipalReference principalRef,
                                                WTRoleHolder2 roleHolder)
                                         throws WTException

Throws:: WTException

createRoleActorRoleMap

private RoleActorRoleMap createRoleActorRoleMap(Role role,
                                                ActorRole actor,
                                                WTActorRoleHolder2 roleHolder)
                                         throws WTException

Throws:: WTException

replaceUser

private void replaceUser(ContainerTeamManaged container,
                         WTUser replacedUser,
                         WTUser newUser)
                  throws WTException

Throws:: WTException

findWorkflowTeams

private static Enumeration findWorkflowTeams(WTUser wtuser,
                                             WTContainer container)
                                      throws WTException

Throws:: WTException

changeAdministrativeDomain

private static void changeAdministrativeDomain(AdminDomainRef d_ref,
                                               TeamReference teamRef)
                                        throws WTException

Throws:: WTException

deleteRolePrincipalMaps

private void deleteRolePrincipalMaps(WTPrincipal principal)
                              throws WTException

Throws:: WTException

deleteRolePrincipalMaps

private static void deleteRolePrincipalMaps(Team team)
                                     throws WTException

Throws:: WTException

buildRemoveMembersWhereClause

private CompositeWhereExpression buildRemoveMembersWhereClause(Map ending,
                                                               Map starting,
                                                               CompositeWhereExpression whereExpression)
                                                        throws WTException

Throws:: WTException

addToHash

private Hashtable addToHash(Hashtable hash,
                            Role role,
                            WTPrincipalReference pRef)

removeFromHash

private Hashtable removeFromHash(Hashtable hash,
                                 Role role,
                                 WTPrincipalReference pRef)

printResults

private void printResults(Map map)

getKey

private String getKey(WTContainerRef ref,
                      String templateName)

findRolePrincipalMap

private QueryResult findRolePrincipalMap(Role role,
                                         WTPrincipal principal,
                                         WTRoleHolder2 roleHolder,
                                         boolean returnDisabled)
                                  throws WTException

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

Supported API: false

Parameters:: role -; principal -; roleHolder -; returnDisabled - - if true, will return disabled users if the roleHolder is a contanier team.
Returns:: QueryResult
Throws:: WTException

updateReadOnlyContainerTeam

private void updateReadOnlyContainerTeam(ContainerTeam team,
                                         RolePrincipalMap rpm,
                                         Role role,
                                         boolean add)
                                  throws WTException

Throws:: WTException

updateReadOnlyTeamTemplate

private void updateReadOnlyTeamTemplate(TeamTemplate teamTemplate,
                                        RolePrincipalMap rpm,
                                        Role role,
                                        boolean add)
                                 throws WTException

Throws:: WTException

updateReadOnlyTeamTemplate

private void updateReadOnlyTeamTemplate(TeamTemplate teamTemplate,
                                        RoleActorRoleMap rarm,
                                        Role role,
                                        boolean add)
                                 throws WTException

Throws:: WTException

addToMap

private void addToMap(Map map,
                      Role role,
                      Object object)

removeFromMap

private void removeFromMap(Map map,
                           Role role,
                           Object object)

cloneMap

private Map cloneMap(Map original)

Clones each list in the map

deleteNonSharedTeams

public void deleteNonSharedTeams(WTCollection collection)
                          throws WTException,
                                 TeamException

Throws:: WTException; TeamException

getMapOfTeams

private Map getMapOfTeams(WTCollection collection)
                   throws WTException

Throws:: WTException

deleteTeams

private void deleteTeams(Set set,
                         QueryResult results)
                  throws WTException

Throws:: WTException

createTeam

private Team createTeam(WTRoleHolder2 roleHolder,
                        String teamName,
                        Persistable object,
                        boolean persist)
                 throws WTException

Throws:: WTException

resolveAllTeamMembers

private Map resolveAllTeamMembers(WTRoleHolder2 roleHolder,
                                  Team team,
                                  Persistable object,
                                  PhaseTemplate phaseTemplate)
                           throws WTException

Throws:: WTException

resolveWTRoleHolder2Roles

private Map resolveWTRoleHolder2Roles(WTRoleHolder2 roleHolder,
                                      Persistable object)
                               throws WTException

Throws:: WTException

resolvePhaseTemplateRoles

private void resolvePhaseTemplateRoles(Map map,
                                       TeamTemplate teamTemplate,
                                       Persistable object,
                                       PhaseTemplate phaseTemplate)
                                throws WTException

Throws:: WTException

resolveByAllPrincipals

private Vector resolveByAllPrincipals(Map map,
                                      Role role,
                                      PhaseTemplate phaseTemplate,
                                      Persistable object,
                                      TeamTemplate teamTemplate,
                                      Vector principals)
                               throws WTException

Throws:: WTException

resolveContainerTeamRoles

private void resolveContainerTeamRoles(Map map,
                                       Persistable object)
                                throws WTException

Throws:: WTException

createRolePrincipalMaps

private WTRoleHolder2 createRolePrincipalMaps(WTCollection collection,
                                              WTRoleHolder2 roleHolder,
                                              Map map)
                                       throws WTException

Throws:: WTException

createRoleActorRoleMaps

private void createRoleActorRoleMaps(WTCollection collection,
                                     WTActorRoleHolder2 roleHolder,
                                     Map map)
                              throws WTException

Throws:: WTException

calculateNewMembers

private Map calculateNewMembers(Map finalMap,
                                Map startingMap)

populateRolePrincipalHash

private Map populateRolePrincipalHash(WTRoleHolder2 roleHolder,
                                      boolean returnDisabled)
                               throws WTException

creates a role-principal mapping of roleholder membership

Parameters:: roleHolder - - the roleholder of interest; returnDisabled - - if true and container is a ContainerTeam the return map includes disabled participants.
Throws:: WTException

findObjectsTeams

private Map findObjectsTeams(WTList list)
                      throws WTException

This API finds all the teams associated with the objects in a collection and stores them.

Throws:: WTException

getRolePrincipalMapsForTeams

private Map getRolePrincipalMapsForTeams(Set set)
                                  throws WTException

Throws:: WTException

removeSecuredPrincipals

private static void removeSecuredPrincipals(Map map)
                                     throws WTException

removeSecuredPrincipals - removes the principals the current session principal does not have access to. Used for copying the teams and team templates.

Throws:: WTException

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

wt.team Class StandardTeamService

RESOURCE

CLASSNAME

IGNORE_DELETE_KEY

TEAM

teamKey

RETEAM_WITHOUT_MODIFYING

VERBOSE

SERVICE_NAME

ENABLED_ONLY

ADD_LC_ROLES_IN_CREATE

BYPASS_DELETE_EVENT_DISPATCH

ALLOW_RERESOLUTION_LC_ROLES

sequencePool

UNDO_CHECKOUT_KEY

deleteRPMSQL

StandardTeamService

getConceptualClassname

performStartupProcess

registerEvents

dispatchVetoableEvent

newStandardTeamService

doReteam

validateReteam

resolveActorRole

createTeams

resolveLCRoles

findCandidateTeamTemplates

findCandidateTeamTemplates

getTeamTemplate

reteam

getMembers

copyTeamTemplate

getTeamTemplate

createTeam

whereUsed

findCandidateTeams

findCandidateTeams

copyTeam

findTeams

findTeams

findTeams

addRolePrincipalMap

addRoleActorRoleMap

addRoleRoleMap

addRolePoolMap

deleteRole

findRolePrincipalMap

deleteRolePrincipalMap

deleteRoleActorRoleMap

deleteRoleRoleMap

deleteRolePoolMap

findRoleActorRoleMap

findRoleRoleMap

findRolePoolMap

findRoles

whereUsed

addLCRoles

createTeamTemplate

getTeamTemplate

getTeam

getTeams

getTeamDistributionList

findCandidateTeamDistributionLists

findCandidateTeamDistributionLists

getTeamDistributionList

getTeamTemplateNames

findTeamTemplates

getTeam

setTeamTemplate

setTeam

getTeamTemplates

setIgnoreDelete

findCandidateTeamTemplates

findCandidateTeamTemplates

copyTeamTemplate

getTeamTemplate

createTeam

createTeamTemplate

getTeamTemplate

wt.team
Class StandardTeamService