com.filenet.api.query
Class SearchTemplateParameters
- java.lang.Object
-
- com.filenet.api.query.SearchTemplateParameters
-
- All Implemented Interfaces:
- java.io.Serializable
public class SearchTemplateParameters extends java.lang.Object implements java.io.Serializable
Identifies the search parameters in the search template that can be modified, excluded or added to 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 search parameters specified for an instance of this class are used for execution of the Stored Search query by aSearchScope
object.The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data.
-
-
Constructor Summary
Constructors Constructor and Description SearchTemplateParameters()
-
Method Summary
Methods Modifier and Type Method and Description java.util.List<java.lang.String>
getAugmentedSelectList()
Retrieves the augmented select list properties to be used for the search.SearchTemplateContent
getContent()
Retrieves the content search that is to be modified for the search.java.lang.Integer
getCountLimit()
Retrieves the maximum result count used for the query.java.util.List<SearchTemplateFolder>
getFolders()
Retrieves the list of folders to be used for the search.java.lang.Integer
getMaximumRecords()
Retrieves the maximum records setting to be used by the search.java.util.List<SearchTemplateSelectProperty>
getSelectProperties()
Retrieves a listing of the select list properties in the search template that are to modified or excluded, as well as any new select list properties to be added for the search.java.util.List<SearchTemplateSubclass>
getSubclasses()
Retrieves a listing of the subclass properties in the search template that are to modified or excluded, as well as any new subclass properties to be added for the search.java.lang.Integer
getTimeLimit()
Retrieves the query time limit for a client-to-server RPC, in seconds.VersionSelection
getVersionSelection()
Retrieves the version selection setting to be used for the search.java.util.List<SearchTemplateWhereProperty>
getWhereProperties()
Retrieves a listing of the Where properties in the search template that are to modified or excluded for the search.void
setAugmentedSelectList(java.util.List<java.lang.String> augmentedSelectList)
Specifies select list properties to augment the select list properties in the search template.void
setContent(SearchTemplateContent content)
Specifies the content search in the search template that is to be modified for the search.void
setCountLimit(java.lang.Integer countLimit)
Specifies that the query returns the result count of the query, up to the count limit provided.void
setFolders(java.util.List<SearchTemplateFolder> folders)
Specifies the list of folders to be added, modified or excluded for the search.void
setMaximumRecords(java.lang.Integer maximumRecords)
Specifies the maximum number of records to be returned by the search.void
setSelectProperties(java.util.List<SearchTemplateSelectProperty> selectProperties)
Specifies the select list properties in the search template that are to modified or excluded, as well as any new select list properties to be added for the search.void
setSubclasses(java.util.List<SearchTemplateSubclass> subclasses)
Specifies the subclass properties in the search template that are to modified or excluded, as well as any new subclass properties to be added for the search.void
setTimeLimit(java.lang.Integer timeLimit)
Specifies the query time limit for a client-to-server RPC, in seconds.void
setVersionSelection(VersionSelection versionSelection)
Specifies the type of version selection to be used.void
setWhereProperties(java.util.List<SearchTemplateWhereProperty> whereProperties)
Specifies the Where properties in the search template that are to modified or excluded for the search.
-
-
-
Method Detail
-
getVersionSelection
public VersionSelection getVersionSelection()
Retrieves the version selection setting to be used for the search. The version selection is specified using thesetVersionSelection
method.- Returns:
- A
VersionSelection
constants object for the type of version selection to use.
-
setVersionSelection
public void setVersionSelection(VersionSelection versionSelection)
Specifies the type of version selection to be used. The version selection specified here overrides the version selection setting in the search template. If null, no change is made to the search template data data.- Parameters:
versionSelection
- AVersionSelection
object specifying the type of version selection to use.
-
getMaximumRecords
public java.lang.Integer getMaximumRecords()
Retrieves the maximum records setting to be used by the search. The maximum records setting is specified using thesetMaximumRecords
method.- Returns:
- An
Integer
indicating the maximum number of records to be returned by the search.
-
setMaximumRecords
public void setMaximumRecords(java.lang.Integer maximumRecords)
Specifies the maximum number of records to be returned by the 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:
maximumRecords
- AnInteger
indicating the maximum number of records to be returned by the search.
-
getAugmentedSelectList
public java.util.List<java.lang.String> getAugmentedSelectList()
Retrieves the augmented select list properties to be used for the search. These properties augment the select list properties specified in the search template. The augmented select list properties are specified using thesetAugmentedSelectList
method.- Returns:
- A
String
array (List
) of the augmented select list properties to be used for the search.
-
setAugmentedSelectList
public void setAugmentedSelectList(java.util.List<java.lang.String> augmentedSelectList)
Specifies select list properties to augment the select list properties in the search template. The property symbolic names must be used for these properties. The search will use the select list properties specified here in addition to the list of select list properties specified in the search template. If null, only the select list properties specified in the search template are used for the search.- Parameters:
augmentedSelectList
- AString
array (List
) of the symbolic names of the select list properties to augment the select list properties specified in the search template.
-
getFolders
public java.util.List<SearchTemplateFolder> getFolders()
Retrieves the list of folders to be used for the search. The folders list is specified using thesetFolders
method.- Returns:
- A
String
array (List
) of the folders to be used for the search.
-
setFolders
public void setFolders(java.util.List<SearchTemplateFolder> folders)
Specifies the list of folders to be added, modified or excluded for the search. The folders specified here override any folders having the same ID that are specified in the search template. If null, no change is made to the search template.- Parameters:
folders
- An array (List
) ofSearchTemplateFolder
objects for the folders to be added, modified or excluded for the search.
-
getSelectProperties
public java.util.List<SearchTemplateSelectProperty> getSelectProperties()
Retrieves a listing of the select list properties in the search template that are to modified or excluded, as well as any new select list properties to be added for the search. These select list properties are specified using thesetSelectProperties
method.- Returns:
- An array (
List
) ofSearchTemplateSelectProperty
objects for the search template select list properties that are to be added, modified or excluded for the search.
-
setSelectProperties
public void setSelectProperties(java.util.List<SearchTemplateSelectProperty> selectProperties)
Specifies the select list properties in the search template that are to modified or excluded, as well as any new select list properties to be added for the search. The select list properties specified will override the select list properties in the search template. If null, no change is made to the search template data.- Parameters:
selectProperties
- An array (List
) ofSearchTemplateSelectProperty
objects for the select list properties that are to be added, modified or excluded for the search.
-
getWhereProperties
public java.util.List<SearchTemplateWhereProperty> getWhereProperties()
Retrieves a listing of the Where properties in the search template that are to modified or excluded for the search. These Where properties are specified using thesetWhereProperties
method.- Returns:
- An array (
List
) ofSearchTemplateWhereProperty
objects for the search template Where properties (whereprop items) that are to be modified or excluded for the search.
-
setWhereProperties
public void setWhereProperties(java.util.List<SearchTemplateWhereProperty> whereProperties)
Specifies the Where properties in the search template that are to modified or excluded for the search. New Where properties cannot be added. The Where properties specified will override the Where properties in the search template. If null, no change is made to the search template.- Parameters:
whereProperties
- An array (List
) ofSearchTemplateWhereProperty
objects for the search template Where properties (whereprop items) that are to be modified or excluded for the search.
-
getContent
public SearchTemplateContent getContent()
Retrieves the content search that is to be modified for the search. The content search is specified using thesetContent
method.- Returns:
- A
SearchTemplateContent
object for the content search to be modified for the search.
-
setContent
public void setContent(SearchTemplateContent content)
Specifies the content search in the search template that is to be modified for the search. A new content search cannot be added. The content search specified will override the select list properties in the search template. If null, no change is made to the search template data.- Parameters:
content
- ASearchTemplateContent
object for the content search in the search template to be modified for the search.
-
getSubclasses
public java.util.List<SearchTemplateSubclass> getSubclasses()
Retrieves a listing of the subclass properties in the search template that are to modified or excluded, as well as any new subclass properties to be added for the search. These subclass properties are specified using thesetSubclasses
method.- Returns:
- An array (
List
) ofSearchTemplateSubclass
objects for the search template subclass properties that are to be added, modified or excluded for the search.
-
setSubclasses
public void setSubclasses(java.util.List<SearchTemplateSubclass> subclasses)
Specifies the subclass properties in the search template that are to modified or excluded, as well as any new subclass properties to be added for the search. The subclass properties specified will override the subclass properties in the search template. If null, no change is made to the search template data.- Parameters:
subclasses
- An array (List
) ofSearchTemplateSubclass
objects for the search template subclass properties that are to be added, modified or excluded for the search.
-
getTimeLimit
public java.lang.Integer getTimeLimit()
Retrieves the query time limit for a client-to-server RPC, in seconds. The query time limit setting is specified using thesetTimeLimit
method.- Returns:
- An
Integer
indicating the query time limit for a client-to-server RPC, in seconds. - See Also:
- Query Options
-
setTimeLimit
public void setTimeLimit(java.lang.Integer timeLimit)
Specifies the query time limit for a client-to-server RPC, in seconds.- Parameters:
timeLimit
- AnInteger
indicating query time limit for a client-to-server RPC, in seconds.- See Also:
- Query Options
-
getCountLimit
public java.lang.Integer getCountLimit()
Retrieves the maximum result count used for the query. The maximum count limit setting is specified using thesetCountLimit
method.- Returns:
- An
Integer
indicating the maximum number of records to be counted by the query. - See Also:
- Query Options
-
setCountLimit
public void setCountLimit(java.lang.Integer countLimit)
Specifies that the query returns the result count of the query, up to the count limit provided.- Parameters:
countLimit
- AnInteger
indicating the maximum number of records to be counted by the query.- See Also:
- Query Options
-
-