Package com.ptc.windchill.enterprise.maturity.configuration

Class PromotionParticipantConfiguration

java.lang.Object

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

com.ptc.windchill.enterprise.maturity.configuration.PromotionParticipantConfiguration

All Implemented Interfaces:

ParticipantConfiguration

public class PromotionParticipantConfiguration
extends DefaultParticipantConfiguration

The configuration delegate for displaying the promotion wizard participant selection table.

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)	Using the selected workflow template determines if the "hideFixedRoles" variable is set to true for hiding all fixed roles from display.
Map<Role,Set<Role>>	getFixedRoleSelection(FormDataHolder formData)	Given the form data returns the initially selected promotion request participants.
Map<Role,Set<Role>>	getInitialRoleSelections(FormDataHolder formData)	The mapping of initially selected participants to work flow process roles.
boolean	isSelectUsersInGroups(FormDataHolder formData)	If the "Group Members Display" promotion preference is set to Yes the users can be selected within groups.

Methods inherited from class com.ptc.windchill.enterprise.wizardParticipant.configuration.DefaultParticipantConfiguration

getInitialRolesFromObjectTeamTemplate, getWorkflowResourcePools

Methods inherited from class java.lang.Object

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

Method Details

getFixedRoleSelection

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

Given the form data returns the initially selected promotion request participants. The keys in the map returned are the roles and the values are the list of resource pool roles.

If the role is mapped to another role via promotion "Fixed Roles For Promote" preference, then we get the initially selected participants from the mapped role. Otherwise we derive the initially selected participants from the given role.

Supported API: true

Specified by:

getFixedRoleSelection in interface ParticipantConfiguration

Overrides:

getFixedRoleSelection in class DefaultParticipantConfiguration

Parameters:

formData -

Returns:

a map of initially selected participants

Throws:

WTException

isSelectUsersInGroups

public boolean isSelectUsersInGroups(FormDataHolder formData)
                              throws WTException

If the "Group Members Display" promotion preference is set to Yes the users can be selected within groups.

Supported API: true

Specified by:

isSelectUsersInGroups in interface ParticipantConfiguration

Overrides:

isSelectUsersInGroups in class DefaultParticipantConfiguration

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. Default is to exclude the OWNER role.

Supported API: true

Specified by:

excludedWorkflowRoles in interface ParticipantConfiguration

Overrides:

excludedWorkflowRoles in class DefaultParticipantConfiguration

Returns:

true

Throws:

WTException

excludedWorkflowRolesForDisplay

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

Using the selected workflow template determines if the "hideFixedRoles" variable is set to true for hiding all fixed roles from display. The workflow template variable "overrideFixedRoleDisplay" can be used in conjunction with the "hideFixedRoles" variable in order to override the filtered fixed roles. To override more than one role use the "|" to separate the roles.

Supported API: true

Specified by:

excludedWorkflowRolesForDisplay in interface ParticipantConfiguration

Overrides:

excludedWorkflowRolesForDisplay in class DefaultParticipantConfiguration

Parameters:

formData -

Returns:

empty set

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. Default is to return an empty map.

Supported API: true

Specified by:

getInitialRoleSelections in interface ParticipantConfiguration

Overrides:

getInitialRoleSelections in class DefaultParticipantConfiguration

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