Package wt.team

Interface TeamService

@RemoteInterface public interface TeamService
TeamService provides client invokable methods to team services. These methods are executed on the server side.

Supported API: true

Extendable: false

  • Method Details

    • findCandidateTeamTemplates

      Vector findCandidateTeamTemplates() throws WTException, TeamException
      Answer a vector of teamTemplate references that the team managed object can be assigned to

      Supported API: true
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • findCandidateTeamTemplates

      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: true
      Parameters:
      domainRef - the domain to search for team templates
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • getTeamTemplate

      TeamTemplate getTeamTemplate(TeamManaged object) throws WTException, TeamException
      Given a TeamManaged object, answer the assigned TeamTemplate

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

    • reteam

      TeamManaged reteam(TeamManaged object, TeamTemplateReference teamTemplateRef) throws WTException, TeamException
      Associate a team managed object with a new team.

      Supported API: true
      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

      Vector getMembers(RoleHolder2 roleHolder) throws WTException
      Answer a vector of WTPrincipalReference of all members of a team object (Team, TeamTemplate or DistributionList)

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

    • copyTeamTemplate

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

    • whereUsed

      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: true
      Parameters:
      team - the team of interest
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • findCandidateTeams

      Vector findCandidateTeams() throws WTException
      Deprecated.
      Answer a vector of team references

      Supported API: true
      Returns:
      Vector
      Throws:
      WTException

    • copyTeam

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

      Vector findTeams() throws WTException
      Deprecated.
      Answer a vector of TeamReferences for all teams that match the input parameters, including the disabled ones

      Supported API: true
      Returns:
      Vector
      Throws:
      WTException

    • addRolePrincipalMap

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

    • addRoleRoleMap

      void addRoleRoleMap(Role leftRole, Role rightRole, WTIndirectRoleHolder2 roleHolder) throws WTException
      Add a role to role assignment to the roleholder

      Supported API: true
      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

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

      void deleteRole(Role role, WTRoleHolder2 roleHolder) throws WTException
      Remove all occurances of a Role object from the role holde

      Supported API: true
      Parameters:
      role - the role to remove from the roleholder
      roleHolder - the roleholder of interest
      Throws:
      WTException

    • findRolePrincipalMap

      QueryResult findRolePrincipalMap(Role role, WTPrincipal principal, WTRoleHolder2 roleHolder) throws WTException
      Based on the input parameters, return a QueryResult of RolePrincipalMap objects

      Supported API: true
      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

      void deleteRolePrincipalMap(Role role, WTPrincipal principal, WTRoleHolder2 roleHolder) throws WTException
      Remove a role to principal assignment from the roleholder

      Supported API: true
      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

    • deleteRoleRoleMap

      void deleteRoleRoleMap(Role leftRole, Role rightRole, WTIndirectRoleHolder2 roleHolder) throws WTException
      Remove a role to role assignment from the roleholder

      Supported API: true
      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

      void deleteRolePoolMap(Role role, WTObject pool, WTRoleHolder2 roleHolder) throws WTException
      Remove a role to pool assignment from the roleholder

      Supported API: true
      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

    • findRoleRoleMap

      QueryResult findRoleRoleMap(Role leftRole, Role rightRole, WTRoleHolder2 roleHolder) throws WTException
      Based on the input parameters, return a QueryResult of RoleRoleMap objects

      Supported API: true
      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

      QueryResult findRolePoolMap(Role role, WTObject pool, WTRoleHolder2 roleHolder) throws WTException
      Based on the input parameters, return a QueryResult of RolePoolMap objects

      Supported API: true
      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

      Vector findRoles(WTRoleHolder2 roleHolder) throws WTException
      Return an enumeration of all roles in the WTRoleHolder2

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

    • whereUsed

      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: true
      Parameters:
      teamTemplate - the team template of interest
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • findCandidateTeamDistributionLists

      Vector findCandidateTeamDistributionLists() throws WTException, TeamException
      Answer a vector of teamDistributionList references that are enabled

      Supported API: true
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • findCandidateTeamDistributionLists

      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: true
      Parameters:
      domainRef - the administrative domain to search in for team distribution lists
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • findTeamTemplates

      Vector findTeamTemplates() throws WTException
      Answer a vector of TeamTemplateReferences for all team templates that match the input parameters, including the disabled ones

      Supported API: true
      Returns:
      Vector
      Throws:
      WTException

    • getTeam

      Team getTeam(TeamManaged object) throws WTException, TeamException
      Given a TeamManaged object, answer the assigned Team Note: As wt.team.Team is not supported in customer JavaDoc, please use wt.team.WTRoleHolder2 to capture the return type

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

    • getTeamTemplates

      Vector getTeamTemplates() throws WTException, TeamException
      Answer a vector of teamTemplate references for all team templates including the disabled ones

      Supported API: true
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • findCandidateTeamTemplates

      Vector findCandidateTeamTemplates(WTContainerRef containerRef) throws WTException, TeamException
      Answer a vector of teamTemplate references that the team managed object can be assigned to

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

    • findCandidateTeamTemplates

      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: true
      Parameters:
      containerRef - the container to search for team templates
      domainRef - the administrative domain to search for team templates
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • copyTeamTemplate

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

    • createTeam

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

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

      TeamTemplate getTeamTemplate(WTContainerRef containerRef, AdministrativeDomain adminDomain, String teamTemplateName) throws WTException, TeamException
      Finds a team template as specified by the input parameters.

      Supported API: true
      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

    • findCandidateTeamDistributionLists

      Vector findCandidateTeamDistributionLists(WTContainerRef containerRef) throws WTException, TeamException
      Answer a vector of teamDistributionList references that are enabled

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

    • findCandidateTeamDistributionLists

      Vector findCandidateTeamDistributionLists(WTContainerRef containerRef, AdminDomainRef domainRef) throws WTException, TeamException
      Answer a vector of teamDistributionList references that are enabled.

      Supported API: true
      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

      TeamDistributionList getTeamDistributionList(WTContainerRef containerRef, AdministrativeDomain adminDomain, String teamDistributionListName) throws WTException, TeamException
      Returns the team distribution list based on the parameters passed in.

      Supported API: true
      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

      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: true
      Parameters:
      containerRef - the container to search for team template names
      Returns:
      Vector
      Throws:
      WTException

    • findTeamTemplates

      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: true
      Parameters:
      containerRef - the container to search for team templates
      Returns:
      Vector
      Throws:
      WTException

    • getTeamTemplates

      Vector getTeamTemplates(WTContainerRef containerRef) throws WTException, TeamException
      Answer a vector of teamTemplate references for all team templates including the disabled ones

      Supported API: true
      Parameters:
      containerRef -
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • setTeamTemplate

      TeamManaged setTeamTemplate(WTContainerRef containerRef, TeamManaged object, String teamTemplateName, String domain) throws WTException, TeamException, WTPropertyVetoException
      Set the teamTemplate of the TeamManaged object

      Supported API: true
      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

    • createTeams

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

    • augmentRoles

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

    • getEnabledTeamTemplate

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

    • findTeamTemplates

      Vector findTeamTemplates(WTContainerRef containerRef, boolean keepFiltered) throws WTException
      Answer a vector of TeamTemplateReferences for all team templates that match the input parameters, including the disabled ones. Filter the results based on the keepFiltered argument (false=filter, true=return all)

      Supported API: true
      Parameters:
      containerRef - the container to search for team templates
      keepFiltered - Indicates whether or not filtered results (Hide/Show) should be returned. Return all results if true, otherwise filter results hidden in the container's context.
      Returns:
      Vector
      Throws:
      WTException

    • getTeamTemplates

      Vector getTeamTemplates(WTContainerRef containerRef, boolean keepFiltered) throws WTException, TeamException
      Answer a vector of teamTemplate references for all team templates including the disabled ones

      Supported API: true
      Parameters:
      containerRef - The container to search for team templates
      keepFiltered - Indicates whether or not filtered results (Hide/Show) should be returned. Return all results if true, otherwise filter results hidden in the container's context.
      Returns:
      Vector
      Throws:
      WTException
      TeamException

    • augmentRoles

      WTCollection augmentRoles(HashMap<LifeCycleManaged,TeamReference> lcmObjectMap) throws WTException, LifeCycleException
      Given a Hash Map of 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: true
      Parameters:
      lcmObjectMap - the object associated to the team that needs to have it's membership updated
      Returns:
      WTCollection
      Throws:
      WTException
      LifeCycleException