Package com.ptc.windchill.enterprise.change2.search

Class ChangeItemPickerConfig

java.lang.Object
com.ptc.jca.mvc.components.AbstractPickerConfig
com.ptc.jca.mvc.components.AbstractItemPickerConfig
com.ptc.windchill.enterprise.change2.search.AbstractChangePickerConfig
com.ptc.windchill.enterprise.change2.search.ChangeItemPickerConfig
All Implemented Interfaces:
com.ptc.mvc.components.PickerConfig
public class ChangeItemPickerConfig extends com.ptc.windchill.enterprise.change2.search.AbstractChangePickerConfig
Item picker configuration for select Change objects. Currently supported search configurations are Change Issue and Change Request.

Supported API: true

Extendable: true

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.ptc.jca.mvc.components.AbstractPickerConfig

    com.ptc.jca.mvc.components.AbstractPickerConfig.ToolbarAttributeConfig

  • Field Summary

    Fields inherited from class com.ptc.windchill.enterprise.change2.search.AbstractChangePickerConfig

    ADMINISTRATIVE_LOCK, LATEST_ITERATION

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChangeItemPickerConfig()
    Initializes that picker without initializes for change object specific configuration.
    ChangeItemPickerConfig(String className)
    Initializes that picker for the given class configuration.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBaseWhereClause(NmCommandBean commandBean)
    The default where clause search for latest iterations only "latestIteration='1'".
    String
    getComponentId(NmCommandBean commandBean)
    The default component id is "associatedChangesPicker".
    protected String
    getPickerTitleName()


    Supported API: true
    String
    getTypeComponentId(NmCommandBean commandBean)


    Supported API: true
    String
    getTypePickerObjectList(NmCommandBean commandBean)
    Given a command bean, this API will return a String list of valid change types based on the current association constraint rules.
    void
    setChangeItemClass(String className)
    Configures the picker for the given class configuration.
    void
    setPickerTitleName(String title)


    Supported API: true
    void
    setTypeComponentId(String id)


    Supported API: true

    Methods inherited from class com.ptc.windchill.enterprise.change2.search.AbstractChangePickerConfig

    getContainer, getContainerOidString, getDefaultVersionValue, getInline, getMultiSelect, getPickerCallback, getPickerId, getPickerTitle, getSingleSelectTypePicker, getTableSuggestAttributeAndLabel, isProject, isProject, setPickerId, setPickerTitle

    Methods inherited from class com.ptc.jca.mvc.components.AbstractItemPickerConfig

    getCustomAccessController, getDefaultIterationValue, getEnableServiceConfigForMultipleTypes, getExcludeSubTypes, getExcludeSubTypesContextPicker, getObjectType, getShowAllObjectTypes, getShowTypePicker, getTypePickerDefaultType, getTypePickerFormat, getTypePickerObjectListInSession, getTypePickerShowRoot, getTypePickerSubTypeDisplay

    Methods inherited from class com.ptc.jca.mvc.components.AbstractPickerConfig

    getContainerRef, getDefaultContextValue, getDefaultHiddenValue, getDefaultValue, getDisplayAttribute, getEditable, getExcludeRef, getHelpSelectorKey, getIncludeShared, getLabel, getNumOfCharsInTextBox, getOkClickFunction, getPickedAttributes, getPickedDataFetcher, getPickerTextBoxLength, getPickerType, getReadOnlyPickerTextBox, getRenderKeyword, getRequired, getSearchResultsFetcherURL, getSearchResultsViewId, getShowWorkingCopy, getTableSuggestServiceKey

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ChangeItemPickerConfig

      public ChangeItemPickerConfig()
      Initializes that picker without initializes for change object specific configuration.

      Supported API: true

    • ChangeItemPickerConfig

      public ChangeItemPickerConfig(String className)
      Initializes that picker for the given class configuration.

      Supported API: true
      Parameters:
      className -

  • Method Details

    • setChangeItemClass

      public void setChangeItemClass(String className)
      Configures the picker for the given class configuration. Currently supported search configurations are Change Issue and Change Request. To specify Change Issue pass in "wt.change2.ChangeIssue". To specify Change Request pass in "wt.change2.ChangeRequest".

      The Change Issue specific configuration:
      Picker Id associatedChangeIssuesPicker
      Picker Title FIND_ASSOCIATED_CHANGEISSUES
      Type Component id Foundation.changePRPicker


      The Change Request specific configuration:
      Picker Id associatedChangeRequestsPicker
      Picker Title FIND_ASSOCIATED_CHANGEREQUESTS
      Type Component id Foundation.changeECRPicker


      Supported API: true
      Parameters:
      className -

    • getComponentId

      public String getComponentId(NmCommandBean commandBean) throws WTException
      The default component id is "associatedChangesPicker".

      Supported API: true
      Overrides:
      getComponentId in class com.ptc.jca.mvc.components.AbstractPickerConfig
      Throws:
      WTException

    • getTypeComponentId

      public String getTypeComponentId(NmCommandBean commandBean) throws WTException


      Supported API: true
      Overrides:
      getTypeComponentId in class com.ptc.jca.mvc.components.AbstractItemPickerConfig
      Throws:
      WTException

    • setTypeComponentId

      public void setTypeComponentId(String id)


      Supported API: true

    • getPickerTitleName

      protected String getPickerTitleName()


      Supported API: true
      Specified by:
      getPickerTitleName in class com.ptc.windchill.enterprise.change2.search.AbstractChangePickerConfig

    • setPickerTitleName

      public void setPickerTitleName(String title)


      Supported API: true

    • getBaseWhereClause

      public String getBaseWhereClause(NmCommandBean commandBean) throws WTException
      The default where clause search for latest iterations only "latestIteration='1'".

      Supported API: true
      Overrides:
      getBaseWhereClause in class com.ptc.jca.mvc.components.AbstractPickerConfig
      Throws:
      WTException

    • getTypePickerObjectList

      public String getTypePickerObjectList(NmCommandBean commandBean) throws WTException
      Given a command bean, this API will return a String list of valid change types based on the current association constraint rules.
      Supported API: true
      Overrides:
      getTypePickerObjectList in class com.ptc.jca.mvc.components.AbstractItemPickerConfig
      Throws:
      WTException