com.filenet.api.query
Class SearchTemplateContent
- java.lang.Object
-
- com.filenet.api.query.SearchTemplateContent
-
- All Implemented Interfaces:
- java.io.Serializable
public class SearchTemplateContent extends java.lang.Object implements java.io.Serializable
Identifies the content search settings in a search template that can be modified 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:
SearchTemplateContentItem
, Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description SearchTemplateContent()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description java.util.List<SearchTemplateContentItem>
getContentItems()
Retrieves the list of content search items to be used for the search.java.lang.Integer
getContentQueryDynamicThreshold()
Retrieves the dynamic threshold value that determines the content search optimization to use, content first or database first.java.lang.Integer
getContentQueryMaximumRecords()
Retrieves the maximum records setting to be used by the content search.ContentQueryOptimization
getContentQueryOptimization()
Retrieves the kind of optimization used for the content search, content first, database first, or dynamic threshold.java.lang.Boolean
getRank()
Retrieves a Boolean value indicating whether content search rank is to be used for the search.java.lang.Boolean
getSummary()
Retrieves a Boolean value indicating whether content search summary is to be used for the search.void
setContentItems(java.util.List<SearchTemplateContentItem> contentItems)
Specifies the content search items to be used for the search.void
setContentQueryDynamicThreshold(java.lang.Integer contentQueryDynamicThreshold)
Specifies the dynamic threshold value that determines the content search optimization to use, content first or database first.void
setContentQueryMaximumRecords(java.lang.Integer contentQueryMaximumRecords)
Specifies the maximum number of records to be returned by the content search.void
setContentQueryOptimization(ContentQueryOptimization contentQueryOptimization)
Specifies the kind of optimization used for content search, content first, database first, or dynamic threshold.void
setRank(java.lang.Boolean rank)
Specifies whether content search rank is to be used for the search.void
setSummary(java.lang.Boolean summary)
Specifies whether the content search summary is used for the search.
-
-
-
Method Detail
-
getRank
public java.lang.Boolean getRank()
Retrieves a Boolean value indicating whether content search rank is to be used for the search.- Returns:
- A
Boolean
value offalse
ornull
if the content search rank value in the search template is to be used;true
if the content search rank value is to be supplied at runtime.
-
setRank
public void setRank(java.lang.Boolean rank)
Specifies whether content search rank is to be used for the search. The value specified here overrides the content search rank setting in the search template. If null, no change is made to the search template.- Parameters:
rank
- ABoolean
value. Iffalse
ornull
, the content search rank setting in the search template is used, iftrue
, the content search rank is used for the search.
-
getSummary
public java.lang.Boolean getSummary()
Retrieves a Boolean value indicating whether content search summary is to be used for the search. The summary for the content search is specified using thesetSummary
method.- Returns:
- A
Boolean
value offalse
ornull
if the content search summary setting in the search template is to be used;true
if the content search summary is to be used for the search.
-
setSummary
public void setSummary(java.lang.Boolean summary)
Specifies whether the content search summary is used for the search. The value specified here overrides the content search summary setting in the search template. If null, no change is made to the search template.- Parameters:
summary
- ABoolean
value. Iffalse
ornull
, the content search summary setting in the search template is used, iftrue
, the content search summary is used for the search.
-
getContentItems
public java.util.List<SearchTemplateContentItem> getContentItems()
Retrieves the list of content search items to be used for the search. The list of content search items is specified using thesetContentItems
method.- Returns:
- A
String
array (List
) of the content search items to be used for the search.
-
setContentItems
public void setContentItems(java.util.List<SearchTemplateContentItem> contentItems)
Specifies the content search items to be used for the search. The content search items specified here overrides the content search items in the search template. If null, no change is made to the list of content search items in the search template.- Parameters:
contentItems
- AString
array (List
) specifying the content search items to be used for the search.
-
getContentQueryMaximumRecords
public java.lang.Integer getContentQueryMaximumRecords()
Retrieves the maximum records setting to be used by the content search. The maximum records setting is specified using thesetContentQueryMaximumRecords
method.- Returns:
- An
Integer
indicating the maximum number of records to be returned by the content search. - See Also:
- Query Result Row Limits
-
setContentQueryMaximumRecords
public void setContentQueryMaximumRecords(java.lang.Integer contentQueryMaximumRecords)
Specifies the maximum number of records to be returned by the content search. The maximum records specified here overrides the maximum records setting in the search template. If null, no change is made to the search template data.- Parameters:
contentQueryMaximumRecords
- AnInteger
indicating the maximum number of records to be returned by the content search.- See Also:
- Query Result Row Limits
-
getContentQueryOptimization
public ContentQueryOptimization getContentQueryOptimization()
Retrieves the kind of optimization used for the content search, content first, database first, or dynamic threshold.- Returns:
- A
ContentQueryOptimization
value indicating the kind of optimization to use for the content search. - See Also:
- CBR Query Optimization
-
setContentQueryOptimization
public void setContentQueryOptimization(ContentQueryOptimization contentQueryOptimization)
Specifies the kind of optimization used for content search, content first, database first, or dynamic threshold. If you specify dynamic threshold, then you must also call thegetContentQueryDynamicThreshold
method.- Parameters:
contentQueryOptimization
- AContentQueryOptimization
value indicating the kind of optimization to use for the content search. search.- See Also:
- CBR Query Optimization
-
getContentQueryDynamicThreshold
public java.lang.Integer getContentQueryDynamicThreshold()
Retrieves the dynamic threshold value that determines the content search optimization to use, content first or database first.- Returns:
- An
Integer
value that the server uses to compare to its estimated number of CBR hits. - See Also:
- CBR Query Optimization
-
setContentQueryDynamicThreshold
public void setContentQueryDynamicThreshold(java.lang.Integer contentQueryDynamicThreshold)
Specifies the dynamic threshold value that determines the content search optimization to use, content first or database first. The server switches from content first to database first based on an estimated number of CBR hits that it compares to the threshold value.- Parameters:
contentQueryDynamicThreshold
- AnInteger
value that the server uses to compare to its estimated number of CBR hits.- See Also:
- CBR Query Optimization
-
-