Package wt.doc

Class WTDocumentStandardConfigSpec

java.lang.Object
wt.doc._WTDocumentStandardConfigSpec
wt.doc.WTDocumentStandardConfigSpec
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable, ConfigSpec
@GenAsObjectMappable(interfaces=ConfigSpec.class,versions=-1278944002615074519L,properties={@GeneratedProperty(name="inUse",type=InUseConfigSpec.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="lifeCycle",type=LifeCycleConfigSpec.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={}))},derivedProperties={@DerivedProperty(name="lifeCycleState",derivedFrom="lifeCycle.lifeCycleState",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setAccess=PRIVATE)),@DerivedProperty(name="workingIncluded",derivedFrom="inUse.inUseByCurrentPrincipalIncluded",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setAccess=PRIVATE,setExceptions={}))}) public class WTDocumentStandardConfigSpec extends _WTDocumentStandardConfigSpec
A ConfigSpec used to filter WTDocuments based on their life cycle state 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 documents at that particular state are eligible.

While documents 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 newWTDocumentStandardConfigSpec static factory method(s), not the WTDocumentStandardConfigSpec 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

    • newWTDocumentStandardConfigSpec

      public static WTDocumentStandardConfigSpec newWTDocumentStandardConfigSpec() throws WTException
      Construct a default WTDocumentStandardConfigSpec.

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

    • newWTDocumentStandardConfigSpec

      public static WTDocumentStandardConfigSpec newWTDocumentStandardConfigSpec(State lifeCycleState) throws WTException
      Construct a WTDocumentStandardConfigSpec, setting the lifeCycleState to the passed-in values.

      Supported API: true
      Parameters:
      lifeCycleState -
      Returns:
      WTDocumentStandardConfigSpec
      Throws:
      WTException

    • initialize

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

      Supported API: true
      Parameters:
      lifeCycleState -
      Throws:
      WTException

    • newWTDocumentStandardConfigSpec

      public static WTDocumentStandardConfigSpec newWTDocumentStandardConfigSpec(State lifeCycleState, boolean a_workingIncluded) throws WTException
      Construct a WTDocumentStandardConfigSpec, setting the lifeCycleState and the workingIncluded to the passed-in values.

      Supported API: true
      Parameters:
      lifeCycleState -
      a_workingIncluded - Boolean flag to specify whether the working objects of the current principal should be included.
      Returns:
      WTDocumentStandardConfigSpec
      Throws:
      WTException

    • initialize

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

      Supported API: true
      Parameters:
      lifeCycleState -
      a_workingIncluded - Boolean flag to specify whether the working objects of the current principal should be included.
      Throws:
      WTException

    • newWTDocumentStandardConfigSpec

      public static WTDocumentStandardConfigSpec newWTDocumentStandardConfigSpec(boolean a_workingIncluded) throws WTException
      Construct a WTDocumentStandardConfigSpec, setting the workingIncluded to the passed-in values.

      Supported API: true
      Parameters:
      a_workingIncluded - Boolean flag to specify whether the working objects of the current principal should be included.
      Returns:
      WTDocumentStandardConfigSpec
      Throws:
      WTException

    • initialize

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

      Supported API: true
      Parameters:
      a_workingIncluded - Boolean flag to specify whether the working objects of the current principal should be included.
      Throws:
      WTException