Package wt.filter

Class NavigationCriteria

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.filter._NavigationCriteria
wt.filter.NavigationCriteria
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, NetFactor, ObjectMappable, Persistable, DisplayIdentification
@GenAsPersistable(superClass=WTObject.class,interfaces={},serializable=EXTERNALIZABLE_BASIC,properties={@GeneratedProperty(name="name",type=java.lang.String.class),@GeneratedProperty(name="configSpecs",type=java.util.List.class,typeParameter="<wt.vc.config.ConfigSpec>",accessors=@PropertyAccessors(getAccess=PRIVATE),columnProperties=@ColumnProperties(persistent=false)),@GeneratedProperty(name="filters",type=java.util.Collection.class,typeParameter="<wt.filter.NavigationFilter2>",columnProperties=@ColumnProperties(persistent=false)),@GeneratedProperty(name="applyToTopLevelObject",type=boolean.class,initialValue="false"),@GeneratedProperty(name="useDefaultForUnresolved",type=boolean.class,initialValue="false"),@GeneratedProperty(name="hideUnresolvedDependents",type=boolean.class,initialValue="false",javaDoc="Indicates whether or not the unresolved dependents should be hidden in navigating a structure"),@GeneratedProperty(name="sharedToAll",type=boolean.class,initialValue="false"),@GeneratedProperty(name="centricity",type=boolean.class,initialValue="false",javaDoc="Indicates whether or not the centricity algorithm should be applied in navigating a structure with this NavigationCriteria. If centricity is true then the collector will navigate the structure of the applicable type directly and any parallel structure by navigating associations to the applicable type structure (e.g. if WTPart is the applicable type and centricity is applied, it will get the EPMDocument structure by navigating from the WTPart structure to related EPMDocuments). Otherwise just the applicable type structure will be navigated."),@GeneratedProperty(name="applicableType",type=java.lang.String.class,javaDoc="Type string for the class that the config specs of this NavigationCriteria are applicable to."),@GeneratedProperty(name="applicationName",type=java.lang.String.class,accessors=@PropertyAccessors(setExceptions={}),javaDoc="The application name used when the NavigationCriteria is cached",columnProperties=@ColumnProperties(persistent=false))},foreignKeys=@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="owner",type=wt.filter.NavigationCriteriaOwner.class,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="theNavigationCriteria",cardinality=ONE,cascade=true)),tableProperties=@TableProperties(compositeUnique1="+ownerReference.key.id+name"),iconProperties=@IconProperties(standardIcon="/netmarkets/images/expansion_criteria.gif",openIcon="/netmarkets/images/expansion_criteria.gif")) public class NavigationCriteria extends wt.filter._NavigationCriteria
An ExpansionCriteria consists of a list of ConfigSpecs used to resolve masters to iterations, and a collection of Filters used in filtering Product Structures. ExpansionCriteria can be shared to other users.

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

    • newNonPersistableNavigationCriteria

      public static final NavigationCriteria newNonPersistableNavigationCriteria(List configSpecs, Collection filters, boolean applyToTopLevelObject, boolean useDefaultForUnresolved, boolean hideUnresolvedDependents, String applicableType, wt.filter.NavigationCriteriaOwner owner) throws Exception
      Default factory for the class to create user defined non persistable navigation criteria for in-memory usage.

      Supported API: true
      Parameters:
      List - of valid configuration Specifications
      WTCollection - of valid filters
      applyToTopLevelObject - (Flag to decide whether navigation criteria is to be applied to top level object)
      useDefaultForUnresolved - (Flag to decide whether default configuration specification to be applied to unresolved objects)
      hideUnresolvedDependents - (Flag to decide whether or not the unresolved dependents should be hidden in navigating a structure)
      applicableType - , type string for the class that the configuration specifications of this NavigationCriteria are applicable to
      owner - , owner of Navigation Criteria
      Returns:
      non persistable Navigation criteria
      Throws:
      Exception

    • newNonPersistableNavigationCriteria

      public static final NavigationCriteria newNonPersistableNavigationCriteria(List configSpecs, Collection filters) throws Exception
      Default factory for the class to create user defined non persistable navigation criteria for in-memory usage with configuration specifications and filters.

      Supported API: true
      Parameters:
      List - of valid configuration Specifications
      WTCollection - of valid filters
      Returns:
      non persistable Navigation criteria
      Throws:
      Exception

    • newNonPersistableNavigationCriteria

      public static final NavigationCriteria newNonPersistableNavigationCriteria(List configSpecs, Collection filters, String applicableType, wt.filter.NavigationCriteriaOwner owner) throws Exception
      Default factory for the class to create user defined non persistable navigation criteria for in-memory usage with configuration specifications and filters.

      Supported API: true
      Parameters:
      List - of valid configuration Specifications
      WTCollection - of valid filters
      applicableType - ,type string for the class that the configuration specifications of this NavigationCriteria are applicable to
      owner - , owner of Navigation Criteria
      Returns:
      non persistable Navigation criteria
      Throws:
      Exception