Package wt.part

Class PlantStandardConfigSpec

java.lang.Object
wt.part._PlantStandardConfigSpec
wt.part.PlantStandardConfigSpec
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable, ConfigSpec
@GenAsObjectMappable(interfaces=ConfigSpec.class,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={}))}) public class PlantStandardConfigSpec extends _PlantStandardConfigSpec
A ConfigSpec used to resolve WTParts based on plant's(EnterpriseData's) life cycle state, membership in a view, and Enterprise Datable's (WTPart's) work in progress state.

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

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

If the view is set, only those parts whose plants are in the view 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 PlantStandardConfigSpec static factory method(s), not the PlantStandardConfigSpec 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

    • newPlantStandardConfigSpec

      public static PlantStandardConfigSpec newPlantStandardConfigSpec() throws WTException
      Construct a default PlantStandardConfigSpec.

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

    • newPlantStandardConfigSpec

      public static PlantStandardConfigSpec newPlantStandardConfigSpec(View view) throws WTException
      Construct a PlantStandardConfigSpec, setting the view to the passed-in values.

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

    • initialize

      protected void initialize(View view) 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

    • newPlantStandardConfigSpec

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

      Supported API: true
      Parameters:
      view -
      lifeCycleState -
      Returns:
      PlantStandardConfigSpec
      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