public class SearchTemplateContentItem
extends java.lang.Object
implements java.io.Serializable
The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data.
Constructor and Description |
---|
SearchTemplateContentItem() |
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.
|
public java.lang.Boolean getExcludeFromQuery()
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.public void setExcludeFromQuery(java.lang.Boolean exclude)
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)
.
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.public java.lang.String getItemId()
setItemId
.String
containing the ID of the content search item to be modified.public void setItemId(java.lang.String itemId)
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.
itemId
- A String
containing the ID of a content search item in the search template.public GroupAction getGroupAction()
setGroupAction
method.GroupAction
constants object for the content search group actions to be available.public void setGroupAction(GroupAction groupAction)
Note: Some group actions may not be applicable to all supported content search engines.
groupAction
- A GroupAction
object specifying the group actions for the content search
item.public java.util.List<java.lang.String> getItemData()
setItemData
method.String
array (List
) of the content search item data to be available.public void setItemData(java.util.List<java.lang.String> itemData)
itemData
- A String
array (List
) specifying the query text for the content
search item.public java.lang.Double getSearchModifierRange()
setSearchModifierRange
method.Double
indicating the content search item search modifier range available.public void setSearchModifierRange(java.lang.Double searchModifierRange)
searchModifierRange
- A Double
indicating the search modifier range for the content search item.public SearchModifier getSearchModifier()
setSearchModifier
method.SearchModifier
constants object specifying the content search item search modifier
to be used.public void setSearchModifier(SearchModifier searchModifier)
Note: Some search modifiers may not be applicable to all supported content search engines.
searchModifier
- A SearchModifer
object specifying the search modifier to use for the
content search item.public RequiredState getRequiredState()
setRequiredState
method.RequiredState
constants object specifying the content search item required state
to be used.public void setRequiredState(RequiredState requiredState)
Note: Some required states may not be applicable to all supported content search engines.
requiredState
- A RequiredState
object specifying the required state for the content search
item.© Copyright IBM Corporation 2006, 2015. All rights reserved.