Package com.ptc.windchill.enterprise.wizardParticipant.configuration

Class DefaultParticipantConfiguration

java.lang.Object

com.ptc.windchill.enterprise.wizardParticipant.configuration.DefaultParticipantConfiguration

All Implemented Interfaces:

ParticipantConfiguration

Direct Known Subclasses:

PromotionParticipantConfiguration

public class DefaultParticipantConfiguration
extends Object
implements ParticipantConfiguration

The default delegate for displaying the wizard participant selection table with different configurations.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
Set<Role>	excludedWorkflowRoles(FormDataHolder formData)	Use determine if only a single user should fulfill the role of the owner and remove any users who are acting as owners.
Set<Role>	excludedWorkflowRolesForDisplay(FormDataHolder formData)	Default is to not hide and workflow role columns for display.
Map<Role,Set<Role>>	getFixedRoleSelection(FormDataHolder formData)	The mapping of fixed initially selected participant roles to work flow process roles.
Map<Role,Set<Role>>	getInitialRoleSelections(FormDataHolder formData)	The mapping of initially selected participants to work flow process roles.
Map<Role,Set<Role>>	getInitialRolesFromObjectTeamTemplate(FormDataHolder formData)	The mapping of initially selected participants to work flow process roles.
Map<Role,WTSet>	getWorkflowResourcePools(FormDataHolder formData)	The resource pools used to display the list of participants available for selection.
WfProcessTemplate	getWorkFlowTemplate(FormDataHolder formData)	Looks up the life cycle template work flow process template from the selected object type in the wizard.
boolean	isSelectUsersInGroups(FormDataHolder formData)	When true users can be selected within groups.

Methods inherited from class java.lang.Object

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

Method Details

getWorkFlowTemplate

public WfProcessTemplate getWorkFlowTemplate(FormDataHolder formData)
                                      throws WTException

Looks up the life cycle template work flow process template from the selected object type in the wizard.

Supported API: true

Specified by:

getWorkFlowTemplate in interface ParticipantConfiguration

Throws:

WTException

getWorkflowResourcePools

public Map<Role,WTSet> getWorkflowResourcePools(FormDataHolder formData)
                                         throws WTException

The resource pools used to display the list of participants available for selection. Uses the work flow process template returned from getWorkFlowTemplate(FormDataHolder) and the context team from the container found in the form data. The map will contain the work flow role as the key and value as a set of supported object types:

• invalid reference

  wt.inf.team.ContainterTeam

• TeamTemplate
• Team
• WTGroup

Supported API: true

Specified by:

getWorkflowResourcePools in interface ParticipantConfiguration

Throws:

WTException

getInitialRoleSelections

public Map<Role,Set<Role>> getInitialRoleSelections(FormDataHolder formData)
                                             throws WTException

The mapping of initially selected participants to work flow process roles. These roles can be unselected by the user. Uses the roles on the object team template defined in the object initialization rules.

Supported API: true

Specified by:

getInitialRoleSelections in interface ParticipantConfiguration

Returns:

a map where the key is the participant role and the value is a set of work flow roles to be selected.

Throws:

WTException

getInitialRolesFromObjectTeamTemplate

public Map<Role,Set<Role>> getInitialRolesFromObjectTeamTemplate(FormDataHolder formData)
                                                          throws WTException

The mapping of initially selected participants to work flow process roles. These roles can be unselected by the user. Uses the roles on the object team template defined in the object initialization rules. This method is called by getInitialRoleSelections(FormDataHolder).

Note that this method is available for customization support for case like the promotion request where getInitialRoleSelections(FormDataHolder) overridden to always return empty.

Supported API: true

Throws:

WTException

getFixedRoleSelection

public Map<Role,Set<Role>> getFixedRoleSelection(FormDataHolder formData)
                                          throws WTException

The mapping of fixed initially selected participant roles to work flow process roles. These roles cannot be unselected by the user. Default is that no roles are marked as fixed.

Supported API: true

Specified by:

getFixedRoleSelection in interface ParticipantConfiguration

Returns:

an empty map

Throws:

WTException

isSelectUsersInGroups

public boolean isSelectUsersInGroups(FormDataHolder formData)
                              throws WTException

When true users can be selected within groups. Default is to support selecting users within groups.

Supported API: true

Specified by:

isSelectUsersInGroups in interface ParticipantConfiguration

Returns:

true

Throws:

WTException

excludedWorkflowRoles

public Set<Role> excludedWorkflowRoles(FormDataHolder formData)
                                throws WTException

Use determine if only a single user should fulfill the role of the owner and remove any users who are acting as owners. Defaults to no roles excluded.

Supported API: true

Specified by:

excludedWorkflowRoles in interface ParticipantConfiguration

Returns:

empty set

Throws:

WTException

excludedWorkflowRolesForDisplay

public Set<Role> excludedWorkflowRolesForDisplay(FormDataHolder formData)
                                          throws WTException

Default is to not hide and workflow role columns for display.

Supported API: true

Specified by:

excludedWorkflowRolesForDisplay in interface ParticipantConfiguration

Parameters:

formData -

Returns:

empty set

Throws:

WTException