Package wt.filter

Class _NavigationFilterTemplate

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.filter._NavigationFilterTemplate
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, AccessControlled, wt.access.PolicyAccessControlled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, wt.federation._FederatedLinkHolder, wt.federation._RemotelyLinkable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.filter._FilterTemplate, wt.filter.FilterTemplate, DisplayIdentification, wt.inf.container._WTContained, WTContained, wt.recent.RecentlyVisited, wt.ufid._Federatable, wt.ufid.Federatable
Direct Known Subclasses:
NavigationFilterTemplate
public abstract class _NavigationFilterTemplate extends WTObject implements wt.access.PolicyAccessControlled, wt.filter.FilterTemplate, wt.ufid.Federatable, WTContained, Externalizable
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DESCRIPTION
    Description of the Navigation Filter Template.
    static final String
    NAME
    Supported API: true
    static final String
    SUPPORT_EXCLUSION
    A flag to indicate whether the filter template option choices marked for exclusion in the filtering process Setting this value to true will expose additional capabilities in Edit Option Rules UI to mark options choices as excluded.
    static final String
    SUPPORT_PART_IBA
    A flag to indicate whether the filter template supports filtering by supporting item option choices.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Description of the Navigation Filter Template.
    String
    getName()
    Supported API: true
    boolean
    isSupportExclusion()
    A flag to indicate whether the filter template option choices marked for exclusion in the filtering process Setting this value to true will expose additional capabilities in Edit Option Rules UI to mark options choices as excluded.
    boolean
    isSupportPartIba()
    A flag to indicate whether the filter template supports filtering by supporting item option choices.
    void
    setDescription(String description)
    Description of the Navigation Filter Template.
    void
    setName(String name)
    Supported API: true
    void
    setSupportExclusion(boolean supportExclusion)
    A flag to indicate whether the filter template option choices marked for exclusion in the filtering process Setting this value to true will expose additional capabilities in Edit Option Rules UI to mark options choices as excluded.
    void
    setSupportPartIba(boolean supportPartIba)
    A flag to indicate whether the filter template supports filtering by supporting item option choices.

    Methods inherited from class wt.fc.WTObject

    getDisplayIdentifier, getDisplayIdentity, getDisplayType

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface wt.fc.Persistable

    checkAttributes

  • Field Details

    • DESCRIPTION

      public static final String DESCRIPTION
      Description of the Navigation Filter Template.

      Supported API: true

      See Also:

    • NAME

      public static final String NAME
      Supported API: true
      See Also:

    • SUPPORT_PART_IBA

      public static final String SUPPORT_PART_IBA
      A flag to indicate whether the filter template supports filtering by supporting item option choices. This value will be used in filter delegates to decide whether choices on supporting items like child WTParts of WTPartUsageLinks will be considered during filtering. When this is set to true, both filterable and supporting object choices will be used for filtering. The default value is false - indicating that filterable's choices will be used for filtering.

      Supported API: true

      See Also:

    • SUPPORT_EXCLUSION

      public static final String SUPPORT_EXCLUSION
      A flag to indicate whether the filter template option choices marked for exclusion in the filtering process Setting this value to true will expose additional capabilities in Edit Option Rules UI to mark options choices as excluded. The default value is false.

      Supported API: true

      See Also:

  • Method Details

    • getDescription

      public String getDescription()
      Description of the Navigation Filter Template.

      Supported API: true

      See Also:

    • setDescription

      public void setDescription(String description) throws WTPropertyVetoException
      Description of the Navigation Filter Template.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • getName

      public String getName()
      Supported API: true
      See Also:

    • setName

      public void setName(String name) throws WTPropertyVetoException
      Supported API: true
      Throws:
      WTPropertyVetoException
      See Also:

    • isSupportPartIba

      public boolean isSupportPartIba()
      A flag to indicate whether the filter template supports filtering by supporting item option choices. This value will be used in filter delegates to decide whether choices on supporting items like child WTParts of WTPartUsageLinks will be considered during filtering. When this is set to true, both filterable and supporting object choices will be used for filtering. The default value is false - indicating that filterable's choices will be used for filtering.

      Supported API: true

      See Also:

    • setSupportPartIba

      public void setSupportPartIba(boolean supportPartIba) throws WTPropertyVetoException
      A flag to indicate whether the filter template supports filtering by supporting item option choices. This value will be used in filter delegates to decide whether choices on supporting items like child WTParts of WTPartUsageLinks will be considered during filtering. When this is set to true, both filterable and supporting object choices will be used for filtering. The default value is false - indicating that filterable's choices will be used for filtering.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • isSupportExclusion

      public boolean isSupportExclusion()
      A flag to indicate whether the filter template option choices marked for exclusion in the filtering process Setting this value to true will expose additional capabilities in Edit Option Rules UI to mark options choices as excluded. The default value is false.

      Supported API: true

      See Also:

    • setSupportExclusion

      public void setSupportExclusion(boolean supportExclusion) throws WTPropertyVetoException
      A flag to indicate whether the filter template option choices marked for exclusion in the filtering process Setting this value to true will expose additional capabilities in Edit Option Rules UI to mark options choices as excluded. The default value is false.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also: