com.filenet.api.query

Class SearchTemplateSubclass

  • java.lang.Object
    • com.filenet.api.query.SearchTemplateSubclass
  • All Implemented Interfaces:
    java.io.Serializable

    public class SearchTemplateSubclass
extends java.lang.Object
implements java.io.Serializable
    Identifies the subclass in a search template that is to be modified or excluded, or a new subclass that is to be added to the search. Methods are provided to supply new values to a subclass being modified.

    The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data.

    See Also:
    SearchTemplateParameters, Serialized Form

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Boolean getExcludeFromQuery()
      Retrieves a Boolean value indicating whether any subclasses in the search template are to be excluded at runtime.
      java.lang.Boolean getIncludeSubclasses()
      Retrieves a Boolean value indicating that a class specified in the included subclasses property (the includesubclasses element) in the search template is to be overridden by a subclass, or a new class added to the include subclasses property.
      java.lang.String getItemId()
      Retrieves the GUID of the subclass to be to be modified, excluded or added for the search.
      java.lang.String getSymbolicName()
      Retrieves the symbolic name of the subclass to be to be modified, excluded or added for the search.
      void setExcludeFromQuery(java.lang.Boolean exclude)
      Excludes from the query one or more subclasses specified in the search template.
      void setIncludeSubclasses(java.lang.Boolean includeSubclasses)
      Indicates that subclasses are to be included in the search.
      void setItemId(java.lang.String itemId)
      Specifies the GUID of the subclass to be to be modified, excluded or added for the search.
      void setSymbolicName(java.lang.String symname)
      Specifies the symbolic name of the subclass to be to be modified, excluded or added for the search.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SearchTemplateSubclass

        public SearchTemplateSubclass()

    • Method Detail

      • getExcludeFromQuery

        public java.lang.Boolean getExcludeFromQuery()
        Retrieves a Boolean value indicating whether any subclasses in the search template are to be excluded at runtime.
        Returns:
        A Boolean value of false or null if no subclasses in the search template are to be excluded at runtime; true if one or more subclasses is to be excluded at runtime.

      • setExcludeFromQuery

        public void setExcludeFromQuery(java.lang.Boolean exclude)
        Excludes from the query one or more subclasses specified in the search template. Defaults to false.

        To exclude a subclass, set this property value to true and add the subclass or subclasses exclusion to the search template parameters using SearchTemplateParameters.setFolders(java.util.List).

        Parameters:
        exclude - A Boolean value. If false or null, no subclasses in the search template are excluded, if true, the subclass or subclasses to be excluded must be specified using SearchTemplateParameters.setFolders. Any subclasses excluded will not be available at runtime.

      • getIncludeSubclasses

        public java.lang.Boolean getIncludeSubclasses()
        Retrieves a Boolean value indicating that a class specified in the included subclasses property (the includesubclasses element) in the search template is to be overridden by a subclass, or a new class added to the include subclasses property. The classes in the included subclasses property are expected to be subclasses of the subclass specified for this instance (using setItemId).
        Returns:
        A Boolean value of false or null if the included subclasses property in the search template is to be used unchanged; true if an existing subclass is to be overridden, or a new subclass added.

      • setIncludeSubclasses

        public void setIncludeSubclasses(java.lang.Boolean includeSubclasses)
        Indicates that subclasses are to be included in the search. The value specified here will override the included subclasses property (the includesubclasses element) in the search template. If a new subclass is being added to the search, a value is required for this property.
        Parameters:
        includeSubclasses - A Boolean value of false or null if the included subclasses property in the search template is to be used unchanged; true if an subclasses are to be included in the search.

      • getItemId

        public java.lang.String getItemId()
        Retrieves the GUID of the subclass to be to be modified, excluded or added for the search. The subclass is specified using the setItemId method.
        Returns:
        A String containing the GUID for the subclass to be modified, excluded or added for the search.

      • setItemId

        public void setItemId(java.lang.String itemId)
        Specifies the GUID of the subclass to be to be modified, excluded or added for the search. This is a required property. The subclass specified will override a subclass in the search template having the same ID. If a subclass is specified that does not exist in the search template, it is assumed to be a new subclass that is to be added to the search. All properties for this instance must be specified if a new subclass is being added to the search.
        Parameters:
        itemId - A String containing the GUID for the subclass to be modified, excluded or added for the search.

      • getSymbolicName

        public java.lang.String getSymbolicName()
        Retrieves the symbolic name of the subclass to be to be modified, excluded or added for the search. The symbolic name is specified using the setSymbolicName method.
        Returns:
        A String containing the symbolic name of the subclass to be modified, excluded or added for the search.

      • setSymbolicName

        public void setSymbolicName(java.lang.String symname)
        Specifies the symbolic name of the subclass to be to be modified, excluded or added for the search. If null, no change is made to the search template data. This property is required if a new subclass is being added to the search.
        Parameters:
        symname - A String containing the symbolic name of the subclass to be modified, excluded or added for the search.

© Copyright IBM Corporation 2006, 2013. All rights reserved.