Package wt.filter

Class NavCriteriaContext

java.lang.Object
wt.filter.NavCriteriaContext
All Implemented Interfaces:
Serializable
public class NavCriteriaContext extends Object implements Serializable
This class defines the parameters that are passed from application code to the service API ConfigService.getConfigSpecFor(NavCriteriaContext) and to delegates that implement GetConfigSpecForDelegate2.

Supported API: true

Extendable: false
See Also:

  • Field Details

    • CONTEXT_OBJECT_TYPE_ID

      public static final String CONTEXT_OBJECT_TYPE_ID
      Key of entry in Map that is set by setMap(Map) and whose corresponding value must be of type TypeIdentifier.

      Supported API: true

      Extendable: false
      See Also:

    • IS_WORKSPACE_CONTEXT

      public static final String IS_WORKSPACE_CONTEXT
      Key of entry in Map that is set by setMap(Map) and whose corresponding value must "true" or "false".

      Supported API: true

      Extendable: false
      See Also:

  • Method Details

    • setWorkspaceRef

      public void setWorkspaceRef(ObjectReference workspaceRef)
      Set the workspace reference in whose context we are getting a default NavigationCriteria.

      Supported API: true

      Extendable: false
      Parameters:
      workspaceRef -

    • getWorkspaceRef

      public ObjectReference getWorkspaceRef()
      Get the workspace reference in whose context we are getting a default NavigationCriteria.

      Supported API: true

      Extendable: false
      Returns:
      ObjectReference

    • setContainerRef

      public void setContainerRef(WTContainerRef containerRef)
      Set the container reference in whose context we are getting a default NavigationCriteria.

      Supported API: true

      Extendable: false
      Parameters:
      containerRef -

    • getContainerRef

      public WTContainerRef getContainerRef()
      Get the container reference in whose context we are getting a default NavigationCriteria.

      Supported API: true

      Extendable: false
      Returns:
      WTContainerRef

    • getProjectContainerRef

      public WTContainerRef getProjectContainerRef()
      Get the proejct container reference that should be used to create the sandbox config spec or null if the config spec should not be a sandbox config spec.

      Supported API: true

      Extendable: false
      Returns:
      The project container reference or null.

    • setApplicableType

      public void setApplicableType(Class<?> applicableType)
      Set the type for which this default NavigationCriteria will be applicable.

      Supported API: true

      Extendable: false
      Parameters:
      applicableType -

    • getApplicableType

      public Class<?> getApplicableType()
      Get the type for which this default NavigationCriteria will be applicable.

      Supported API: true

      Extendable: false
      Returns:
      Classinvalid input: '<'?>

    • setApplicationName

      public void setApplicationName(String applicationName)
      Set the application for which this default NavigationCriteria is being retrieved.

      Supported API: true

      Extendable: false
      Parameters:
      applicationName -

    • getApplicationName

      public String getApplicationName()
      Get the application for which this default NavigationCriteria is being retrieved.

      Supported API: true

      Extendable: false
      Returns:
      Classinvalid input: '<'?>

    • setSeeds

      public void setSeeds(WTCollection seeds)
      Set the seeds for which this default NavigationCriteria is being retrieved.

      Supported API: true

      Extendable: false
      Parameters:
      seeds -

    • getSeeds

      public WTCollection getSeeds()
      Get the seeds for which this default NavigationCriteria is being retrieved.

      Supported API: true

      Extendable: false
      Returns:
      WTCollection

    • getMap

      public Map<String,Object> getMap()
      Get the map of application defined parameters.

      Supported API: true

      Extendable: false
      Returns:
      The map.

    • setMap

      public void setMap(Map<String,Object> map)
      Set the map of application defined parameters.

      Supported API: true

      Extendable: false
      Parameters:
      map - The map.

    • getVariantSpecRef

      public ObjectReference getVariantSpecRef()
      Get the Variant Spec reference for which this default NavigationCriteria is being retrieved.

      Supported API: true

      Extendable: false
      Returns:
      Variant Spec ObjectReference

    • setVariantSpecRef

      public void setVariantSpecRef(ObjectReference variantSpecRef)
      Set the Variant Spec reference for which this default NavigationCriteria is being retrieved.

      Supported API: true

      Extendable: false
      Parameters:
      variantSpecRef -

    • calculateDerivedParameters

      public void calculateDerivedParameters() throws WTException
      Validates this object has the necessary parameters and assigns values to parameters that can be calculated.

      Supported API: true

      Extendable: false
      Throws:
      WTException