Package wt.vc.config

Class ViewConfigSpec

java.lang.Object
wt.vc.config._ViewConfigSpec
wt.vc.config.ViewConfigSpec
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, NetFactor, ObjectMappable, ConfigSpec
@GenAsObjectMappable(interfaces=ConfigSpec.class,versions={6137893894671867574L,2226415949472060837L},properties={@GeneratedProperty(name="parentIncluded",type=boolean.class,initialValue="true",supportedAPI=PUBLIC,javaDoc="If set to true, search the parents of the view if no match is found for the view-dependent versions of the master. If false, only versions in the specified view or view-dependent will match."),@GeneratedProperty(name="viewRef",type=ViewReference.class,supportedAPI=PRIVATE,accessors=@PropertyAccessors(getAccess=PRIVATE,setExceptions={})),@GeneratedProperty(name="variation1",type=Variation1.class),@GeneratedProperty(name="variation2",type=Variation2.class)}) public class ViewConfigSpec extends _ViewConfigSpec
The ViewConfigSpec can be used to filter ViewManageable elements based on view membership. If 'isParentIncluded()' is set to false, only view-independent and view-dependent versions that are in the specified view are returned. Otherwise, for view-dependent versions not in the specified view, the parents are also searched until a match is found or there are no more parents to search.

Use the newViewConfigSpec static factory method(s), not the ViewConfigSpec 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() throws ObjectNoLongerExistsException
      Gets the value of the attribute: VIEW. The view to match. A null indicates that only view-independent elements are desired.

      Supported API: true
      Returns:
      View
      Throws:
      ObjectNoLongerExistsException

    • setView

      public void setView(View a_View) throws WTPropertyVetoException
      Sets the value of the attribute: VIEW. The view to match. A null indicates that only view-independent elements are desired.

      Supported API: true
      Parameters:
      a_View -
      Throws:
      WTPropertyVetoException

    • appendSearchCriteria

      public QuerySpec appendSearchCriteria(QuerySpec querySpec) throws WTException, QueryException
      Appends a "view = getView() OR view = null" to the QuerySpec if isParentIncluded() is false, otherwise appends "view = getView() OR view = parentView [...] OR view = null". Note that if the view is null, the view = null condition will still apply, and only view-independent objects will be returned. Appends "AND variation1 is null" to the QuerySpec if variation1 is null. Appends "AND variation2 is null" to the QuerySpec if variation2 is null.

      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 view-independent versions and versions in the current view. If isParentIncluded() and there are no versions for a particular master in the specified view, the view's parents are checked until there is a match or no views remain. Also filters by variations if they are enabled.

      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:

    • newViewConfigSpec

      public static ViewConfigSpec newViewConfigSpec(View view) throws WTPropertyVetoException
      Constructs a new ViewConfigSpec using the specified view.

      Supported API: true
      Parameters:
      view -
      Returns:
      ViewConfigSpec
      Throws:
      WTPropertyVetoException

    • initialize

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

      Supported API: true
      Parameters:
      view -
      Throws:
      WTPropertyVetoException

    • newViewConfigSpec

      public static ViewConfigSpec newViewConfigSpec(View view, Variation1 variation1, Variation2 variation2) throws WTPropertyVetoException
      Constructs a new ViewConfigSpec using the specified view, variation1 and variation2.

      Supported API: true
      Parameters:
      view -
      variation1 -
      variation2 -
      Returns:
      ViewConfigSpec
      Throws:
      WTPropertyVetoException

    • initialize

      protected void initialize(View view, Variation1 variation1, Variation2 variation2) throws WTPropertyVetoException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Parameters:
      view -
      variation1 -
      variation2 -
      Throws:
      WTPropertyVetoException