com.filenet.api.query

Class SearchTemplateContentItem

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

    public class SearchTemplateContentItem
extends java.lang.Object
implements java.io.Serializable
    Identifies the content search item settings in a search template that can be modified or excluded for runtime purposes and enables you to choose whether the search template settings or the property values specified for this class are to be used for the search.

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

    See Also:
    SearchTemplateContent, SearchTemplateParameters, Serialized Form

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Boolean getExcludeFromQuery()
      Retrieves a Boolean value indicating whether any content search items in the search template are to be excluded.
      GroupAction getGroupAction()
      Retrieves the group actions to be available for the content search item.
      java.util.List<java.lang.String> getItemData()
      Retrieves the content search item data (the query text) to be used.
      java.lang.String getItemId()
      Retrieves the ID of the content search item to be modified.
      RequiredState getRequiredState()
      Retrieves the content search item required state to be used.
      SearchModifier getSearchModifier()
      Retrieves the content search item search modifier to be used.
      java.lang.Double getSearchModifierRange()
      Retrieves the content search item search modifier range to be used.
      void setExcludeFromQuery(java.lang.Boolean exclude)
      Excludes from the search one or more content search items specified in the search template.
      void setGroupAction(GroupAction groupAction)
      Specifies the group actions for the content search item to be used.
      void setItemData(java.util.List<java.lang.String> itemData)
      Specifies the content search item data (the query text) to be used.
      void setItemId(java.lang.String itemId)
      Specifies the ID of a content search item in the search template to be modified or excluded.
      void setRequiredState(RequiredState requiredState)
      Specifies the content search item required state to be used.
      void setSearchModifier(SearchModifier searchModifier)
      Specifies a search modifier to use for the content search item.
      void setSearchModifierRange(java.lang.Double searchModifierRange)
      Specifies the content search item search modifier range to be used.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SearchTemplateContentItem

        public SearchTemplateContentItem()

    • Method Detail

      • getExcludeFromQuery

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

      • setExcludeFromQuery

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

        To exclude a content search item, set this property value to true and add the content search item exclusion to the search template parameters using SearchTemplateParameters.setContent(SearchTemplateContent).

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

      • getItemId

        public java.lang.String getItemId()
        Retrieves the ID of the content search item to be modified. This content search item is specified using the setItemId.
        Returns:
        A String containing the ID of the content search item to be modified.

      • setItemId

        public void setItemId(java.lang.String itemId)
        Specifies the ID of a content search item in the search template to be modified or excluded. This is a required property.

        New content search items cannot be added to a query, so the itemId value must match the ID of a content search item existing in the search template.

        Parameters:
        itemId - A String containing the ID of a content search item in the search template.

      • getGroupAction

        public GroupAction getGroupAction()
        Retrieves the group actions to be available for the content search item. The group actions for the content search item is specified using the setGroupAction method.
        Returns:
        A GroupAction constants object for the content search group actions to be available.

      • setGroupAction

        public void setGroupAction(GroupAction groupAction)
        Specifies the group actions for the content search item to be used. The group actions specified will override the group actions for the content search item in the search template (the groupaction element). If null, no change is made to the group actions for the content search item in the search template.

        Note: Some group actions may not be applicable to all supported content search engines.

        Parameters:
        groupAction - A GroupAction object specifying the group actions for the content search item.

      • getItemData

        public java.util.List<java.lang.String> getItemData()
        Retrieves the content search item data (the query text) to be used. The query text for the content search item is specified using the setItemData method.
        Returns:
        A String array (List) of the content search item data to be available.

      • setItemData

        public void setItemData(java.util.List<java.lang.String> itemData)
        Specifies the content search item data (the query text) to be used. The content search item query text specified here overrides the content search item query text in the search template. If null, no change is made to the query text for the content search item in the search template.
        Parameters:
        itemData - A String array (List) specifying the query text for the content search item.

      • getSearchModifierRange

        public java.lang.Double getSearchModifierRange()
        Retrieves the content search item search modifier range to be used. The search modifier range for the content search item is specified using the setSearchModifierRange method.
        Returns:
        A Double indicating the content search item search modifier range available.

      • setSearchModifierRange

        public void setSearchModifierRange(java.lang.Double searchModifierRange)
        Specifies the content search item search modifier range to be used. The content search item search modifier range specified here overrides the content search item search modifier range in the search template. If null, no change is made to the search modifier range for the content search item in the search template.
        Parameters:
        searchModifierRange - A Double indicating the search modifier range for the content search item.

      • getSearchModifier

        public SearchModifier getSearchModifier()
        Retrieves the content search item search modifier to be used. The search modifier for the content search item is specified using the setSearchModifier method.
        Returns:
        A SearchModifier constants object specifying the content search item search modifier to be used.

      • setSearchModifier

        public void setSearchModifier(SearchModifier searchModifier)
        Specifies a search modifier to use for the content search item. The content search item search modifier specified here overrides the content search item search modifier in the search template. If null, no change is made to the search modifier for the content search item in the search template.

        Note: Some search modifiers may not be applicable to all supported content search engines.

        Parameters:
        searchModifier - A SearchModifer object specifying the search modifier to use for the content search item.

      • getRequiredState

        public RequiredState getRequiredState()
        Retrieves the content search item required state to be used. The required state for the content search item is specified using the setRequiredState method.
        Returns:
        A RequiredState constants object specifying the content search item required state to be used.

      • setRequiredState

        public void setRequiredState(RequiredState requiredState)
        Specifies the content search item required state to be used. The content search item required state specified here overrides the content search item required state in the search template. If null, no change is made to the required state for the content search item in the search template.

        Note: Some required states may not be applicable to all supported content search engines.

        Parameters:
        requiredState - A RequiredState object specifying the required state for the content search item.

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