public class SearchTemplateParameters
extends java.lang.Object
implements java.io.Serializable
SearchScope
object.
The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data.
Constructor and Description |
---|
SearchTemplateParameters() |
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.
|
public VersionSelection getVersionSelection()
setVersionSelection
method.VersionSelection
constants object for the type of version selection to use.public void setVersionSelection(VersionSelection versionSelection)
versionSelection
- A VersionSelection
object specifying the type of version selection to use.public java.lang.Integer getMaximumRecords()
setMaximumRecords
method.Integer
indicating the maximum number of records to be returned by the search.public void setMaximumRecords(java.lang.Integer maximumRecords)
maximumRecords
- An Integer
indicating the maximum number of records to be returned by the
search.public java.util.List<java.lang.String> getAugmentedSelectList()
setAugmentedSelectList
method.String
array (List
) of the augmented select list properties to be used
for the search.public void setAugmentedSelectList(java.util.List<java.lang.String> augmentedSelectList)
augmentedSelectList
- A String
array (List
) of the symbolic names of the
select list properties to augment the select list properties specified in the search template.public java.util.List<SearchTemplateFolder> getFolders()
setFolders
method.String
array (List
) of the folders to be used
for the search.public void setFolders(java.util.List<SearchTemplateFolder> folders)
folders
- An array (List
) of SearchTemplateFolder
objects for the folders
to be added, modified or excluded for the search.public java.util.List<SearchTemplateSelectProperty> getSelectProperties()
setSelectProperties
method.List
) of SearchTemplateSelectProperty
objects for the search
template select list properties that are to be added, modified or excluded for the search.public void setSelectProperties(java.util.List<SearchTemplateSelectProperty> selectProperties)
selectProperties
- An array (List
) of SearchTemplateSelectProperty
objects for
the select list properties that are to be added, modified or excluded for the search.public java.util.List<SearchTemplateWhereProperty> getWhereProperties()
setWhereProperties
method.List
) of SearchTemplateWhereProperty
objects for the search
template Where properties (whereprop items) that are to be modified or excluded for the search.public void setWhereProperties(java.util.List<SearchTemplateWhereProperty> whereProperties)
whereProperties
- An array (List
) of SearchTemplateWhereProperty
objects
for the search template Where properties (whereprop items) that are to be modified or excluded for the search.public SearchTemplateContent getContent()
setContent
method.SearchTemplateContent
object for the content search to be modified for the search.public void setContent(SearchTemplateContent content)
content
- A SearchTemplateContent
object for the content search in the search template
to be modified for the search.public java.util.List<SearchTemplateSubclass> getSubclasses()
setSubclasses
method.List
) of SearchTemplateSubclass
objects for the search
template subclass properties that are to be added, modified or excluded for the search.public void setSubclasses(java.util.List<SearchTemplateSubclass> subclasses)
subclasses
- An array (List
) of SearchTemplateSubclass
objects for the search
template subclass properties that are to be added, modified or excluded for the search.public java.lang.Integer getTimeLimit()
setTimeLimit
method.Integer
indicating the query time limit for a client-to-server RPC, in seconds.public void setTimeLimit(java.lang.Integer timeLimit)
timeLimit
- An Integer
indicating query time limit for a client-to-server RPC, in seconds.public java.lang.Integer getCountLimit()
setCountLimit
method.Integer
indicating the maximum number of records to be counted by the query.public void setCountLimit(java.lang.Integer countLimit)
countLimit
- An Integer
indicating the maximum number of records to be counted by the query.© Copyright IBM Corporation 2006, 2015. All rights reserved.