Package wt.part

Class WTPartStandardConfigSpec

java.lang.Object
wt.part._WTPartStandardConfigSpec
wt.part.WTPartStandardConfigSpec
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable, ConfigSpec
Direct Known Subclasses:
ESIDefaultConfigSpec
@GenAsObjectMappable(interfaces=ConfigSpec.class,versions={4127926987256387680L,-7014225605540829912L},properties={@GeneratedProperty(name="lifeCycleState",type=State.class,supportedAPI=PUBLIC,javaDoc="If set, ONLY those WTParts at this particular state are returned.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="workingIncluded",type=boolean.class,initialValue="true",supportedAPI=PUBLIC,javaDoc="If true, include any working copies I may have.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="viewRef",type=ViewReference.class,supportedAPI=PRIVATE,accessors=@PropertyAccessors(getAccess=PRIVATE,setExceptions={})),@GeneratedProperty(name="variation1",type=Variation1.class,supportedAPI=PUBLIC,javaDoc="If set, only those objects assigned to the variation1 are returned. If no WTParts match the variation1, other variation1s are checked from the bottom of the hierarchy up(until there is either at least one match or no parent). WTParts with null variation1 are checked last. If this is not set only WTParts with null variation1 will be returned."),@GeneratedProperty(name="variation2",type=Variation2.class,supportedAPI=PUBLIC,javaDoc="If set, only those objects assigned to the variation2 are returned. If no WTParts match the variation2, other variation2s are checked from the bottom of the hierarchy up(until there is either at least one match or no parent). WTParts with null variation2 are checked last. If this is not set only WTParts with null variation2 will be returned.")}) public class WTPartStandardConfigSpec extends _WTPartStandardConfigSpec
A ConfigSpec used to filter WTParts based on their life cycle state, membership in a view, and work in progress state.

This ConfigSpec considers only versions (latest iterations), and returns at most one version per master (the latest eligible version).

If the State value is set, only those parts at that particular state are eligible.

If the view is set, only those parts in the view and any of its parents (and any view-independent versions) are eligible, although the parts assigned the view are taken over any assigned to parent views, unless there is none assigned to the view, in which case the parents are checked until there's at least one version assigned to a parent view. If the view is not set, only view-independent versions are eligible.

While parts owned by any user other than the current principal are never eligible, the user's own versions are only eligible when workingIncluded is set to true (the default).

Use the newWTPartStandardConfigSpec static factory method(s), not the WTPartStandardConfigSpec constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:

  • Method Details

    • getView

      public View getView()
      Gets the value of the attribute: VIEW. If set, only those objects assigned to the view or view-independent are returned. If no WTParts match the view, the parent is checked (until there is either at least one match or no parent). If not set, only view-independent parts are returned.

      Supported API: true
      Returns:
      View

    • setView

      public void setView(View a_View) throws WTPropertyVetoException
      Sets the value of the attribute: VIEW. If set, only those objects assigned to the view or view-independent are returned. If no WTParts match the view, the parent is checked (until there is either at least one match or no parent). If not set, only view-independent parts are returned.

      Supported API: true
      Parameters:
      a_View -
      Throws:
      WTPropertyVetoException

    • newWTPartStandardConfigSpec

      public static WTPartStandardConfigSpec newWTPartStandardConfigSpec() throws WTException
      Construct a default WTPartStandardConfigSpec.

      Supported API: true
      Returns:
      WTPartStandardConfigSpec
      Throws:
      WTException

    • initialize

      protected void initialize() throws WTException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Throws:
      WTException

    • newWTPartStandardConfigSpec

      public static WTPartStandardConfigSpec newWTPartStandardConfigSpec(View view, State lifeCycleState) throws WTException
      Construct a WTPartStandardConfigSpec, setting the view and lifeCycleState to the passed-in values.

      Supported API: true
      Parameters:
      view -
      lifeCycleState -
      Returns:
      WTPartStandardConfigSpec
      Throws:
      WTException

    • initialize

      protected void initialize(View view, State lifeCycleState) throws WTException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Parameters:
      view -
      lifeCycleState -
      Throws:
      WTException