Package wt.vc.config

Class LifeCycleConfigSpec

java.lang.Object
wt.vc.config._LifeCycleConfigSpec
wt.vc.config.LifeCycleConfigSpec
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable, ConfigSpec
Direct Known Subclasses:
wt.vc.config._PlantLifeCycleConfigSpec
@GenAsObjectMappable(interfaces=ConfigSpec.class, versions=-8608192758237350146L, properties=@GeneratedProperty(name="lifeCycleState",type=State.class,supportedAPI=PUBLIC,javaDoc="The state to filter elements on.")) public class LifeCycleConfigSpec extends _LifeCycleConfigSpec
The LifeCycleConfigSpec can be applied to LifeCycleManaged elements to filter them based on life cycle state. Only those elements at the specified life cycle state will be returned.

Use the newLifeCycleConfigSpec static factory method(s), not the LifeCycleConfigSpec 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

    • setLifeCycleState

      public void setLifeCycleState(State a_LifeCycleState) throws WTPropertyVetoException
      Sets the value of the attribute: LIFE_CYCLE_STATE. The state to filter elements on.

      Supported API: true
      Overrides:
      setLifeCycleState in class _LifeCycleConfigSpec
      Parameters:
      a_LifeCycleState -
      Throws:
      WTPropertyVetoException
      See Also:

    • appendSearchCriteria

      public QuerySpec appendSearchCriteria(QuerySpec querySpec) throws WTException, QueryException
      Appends a "lifecyclestate = getLifeCycleState()" to the QuerySpec, indicating that all elements must be at the particular state.

      Supported API: true
      Parameters:
      querySpec - A QuerySpec with a target class that is Iterated.
      Returns:
      QuerySpec
      Throws:
      WTException
      QueryException
      See Also:

    • process

      public QueryResult process(QueryResult results) throws WTException
      Returns a clone of the results. No processing is done: it is expected that the results have already been pre-filtered by the search.

      Supported API: true
      Parameters:
      results - QueryResult of iterations to filter. Assumed to be the result of a query that included the additional search conditions applied by appendSearchCriteria. Note that after enumerating through the elements of this QueryResult, it should be reset.
      Returns:
      QueryResult
      Throws:
      WTException
      See Also:

    • newLifeCycleConfigSpec

      public static LifeCycleConfigSpec newLifeCycleConfigSpec(State lifeCycleState) throws WTPropertyVetoException
      Constructs a new LifeCycleConfigSpec using the specified state.

      Supported API: true
      Parameters:
      lifeCycleState -
      Returns:
      LifeCycleConfigSpec
      Throws:
      WTPropertyVetoException

    • initialize

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

      Supported API: true
      Parameters:
      lifeCycleState -
      Throws:
      WTPropertyVetoException