com.filenet.api.query

Class SearchTemplateSelectProperty

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

    public class SearchTemplateSelectProperty
extends java.lang.Object
implements java.io.Serializable
    Identifies the select list property in a search template that is to be modified or excluded, or a new select list property that is to be added to the search. Methods are provided to supply new values to a select list property 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()
      Retrieve the merge data ExcludeFromQuery.
      java.lang.String getItemId()
      Retrieve the merge data ItemId.
      java.lang.Integer getSortLevel()
      Retrieve the merge data SortLevel.
      SortOrder getSortOrder()
      Retrieve the merge data SortOrder.
      java.lang.String getSymbolicName()
      Retrieve the merge data selectprop symbolic name.
      void setExcludeFromQuery(java.lang.Boolean exclude)
      Set this property to TRUE and add to SearchTemplateParameters to exclude an existing item from query.
      void setItemId(java.lang.String itemId)
      Set this property match an existing selectprop item in the Search Template for modification or exclusion, or a unique value to add a new selectprop item to the query.
      void setSortLevel(java.lang.Integer sortLevel)
      Set this property to override existing selectprop sort level in the Search Template, or provide a sort level for a new selectprop item being added to the query.
      void setSortOrder(SortOrder sortOrder)
      Set this property to override existing selectprop sort order in the Search Template, or provide a sort order for a new selectprop item being added to the query.
      void setSymbolicName(java.lang.String symname)
      Set this property to override existing selectprop symbolic name in the Search Template, or provide a symbolic name for a new selectprop item being added to the query.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SearchTemplateSelectProperty

        public SearchTemplateSelectProperty()

    • Method Detail

      • getExcludeFromQuery

        public java.lang.Boolean getExcludeFromQuery()
        Retrieve the merge data ExcludeFromQuery.

      • setExcludeFromQuery

        public void setExcludeFromQuery(java.lang.Boolean exclude)
        Set this property to TRUE and add to SearchTemplateParameters to exclude an existing item from query. Default value is FALSE
        Parameters:
        exclude - A Boolean instance; if TRUE, excludes existing item from query.

      • getSymbolicName

        public java.lang.String getSymbolicName()
        Retrieve the merge data selectprop symbolic name.

      • setSymbolicName

        public void setSymbolicName(java.lang.String symname)
        Set this property to override existing selectprop symbolic name in the Search Template, or provide a symbolic name for a new selectprop item being added to the query. If a new selectprop item is being added to the query, this property is required. If the property is null, no modification of Search Template.
        Parameters:
        symname - A String instance, the symbolic name for a subclass.

      • getSortLevel

        public java.lang.Integer getSortLevel()
        Retrieve the merge data SortLevel.

      • setSortLevel

        public void setSortLevel(java.lang.Integer sortLevel)
        Set this property to override existing selectprop sort level in the Search Template, or provide a sort level for a new selectprop item being added to the query. If a new selectprop item is being added to the query, this property is required. If the property is null, no modification of Search Template.
        Parameters:
        sortLevel - An Integer instance, specifies a sort level for the selectprop. A value of 0 disables.

      • getSortOrder

        public SortOrder getSortOrder()
        Retrieve the merge data SortOrder.

      • setSortOrder

        public void setSortOrder(SortOrder sortOrder)
        Set this property to override existing selectprop sort order in the Search Template, or provide a sort order for a new selectprop item being added to the query. If a new selectprop item is being added to the query, this property is required. If the property is null, no modification of Search Template.
        Parameters:
        sortOrder - An SortOrder instance, specifies a sort order for the selectprop. A value of ASCENDING or DESCENDING.

      • getItemId

        public java.lang.String getItemId()
        Retrieve the merge data ItemId.

      • setItemId

        public void setItemId(java.lang.String itemId)
        Set this property match an existing selectprop item in the Search Template for modification or exclusion, or a unique value to add a new selectprop item to the query. If a new selectprop item is being added to the query, all properties must be set or an exception will be thrown.
        Parameters:
        itemId - A String instance, either match existing selectprop item in Search Template, or unique value when adding a new selectprop item to the query. A required property.

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