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

Interface ParticipantConfiguration

All Known Implementing Classes:
DefaultParticipantConfiguration, PromotionParticipantConfiguration
public interface ParticipantConfiguration
To override the display of the participant selection picker in the change task or promotion request wizard the default ParticipantConfiguration delegate can be extended to provide the desired behavior. The default delegate for the change task is DefaultParticipantConfiguration and for promotion request is PromotionParticipantConfiguration. Note that directly implementing the ParticipantConfiguration delegate is not supported. To make use of the customized participant configuration delegate it must be first registered in the typedservice.properties for the type of object that the delegate is to be used for. Currently the supported types are promotion request, change task and any sub types. The following is the example of a delegate registered for the Promotion Request object.

<Service context="default" name= "com.ptc.windchill.enterprise.wizardParticipant.configuration.ParticipantConfiguration" >
<Option requestor="wt.maturity.PromotionNotice" selector="wizardParticipantConfiguration" serviceClass= "com.ptc.windchill.enterprise.maturity.configuration.PromotionParticipantConfiguration" />
</Service>

Supported API: true

Extendable: false

  • Method Details

    • getWorkFlowTemplate

      WfProcessTemplate getWorkFlowTemplate(FormDataHolder formData) throws WTException
      The work flow process template which is used to define the displayed work flow roles for selection and the resource pools used to display the list of participants.

      Supported API: true
      Throws:
      WTException

    • getWorkflowResourcePools

      Map<Role,WTSet> getWorkflowResourcePools(FormDataHolder formData) throws WTException
      The resource pools used to display the list of participants available for selection. The map will contain the work flow role as the key and value as a set of supported object types:


      Supported API: true
      Throws:
      WTException

    • getInitialRoleSelections

      Map<Role,Set<Role>> getInitialRoleSelections(FormDataHolder formData) throws WTException
      The mapping of initially selected participant roles to work flow process roles be selected. These roles can be unselected by the user.

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

    • getFixedRoleSelection

      Map<Role,Set<Role>> getFixedRoleSelection(FormDataHolder formData) throws WTException
      The mapping of fixed initially selected participant roles to work flow process roles to be selected. These roles cannot be unselected by the user.

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

    • isSelectUsersInGroups

      boolean isSelectUsersInGroups(FormDataHolder formData) throws WTException
      When true users can be selected within groups.

      Supported API: true
      Throws:
      WTException

    • excludedWorkflowRoles

      Set<Role> excludedWorkflowRoles(FormDataHolder formData) throws WTException
      Used to filter work flow roles.

      Supported API: true
      Throws:
      WTException

    • excludedWorkflowRolesForDisplay

      Set<Role> excludedWorkflowRolesForDisplay(FormDataHolder formData) throws WTException
      Used to hide the workflow role columns from the participant table. Any fixed role selections will still be processed and stored on the object team.

      Supported API: true
      Parameters:
      formData -
      Throws:
      WTException