public class SearchTemplateFolder
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.
SearchTemplateParameters
,
Serialized FormConstructor and Description |
---|
SearchTemplateFolder() |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getExcludeFromQuery()
Retrieves a Boolean value indicating whether any folders in the search template are to
be excluded at runtime.
|
Folder |
getFolder()
Retrieves the folder to be available at runtime.
|
java.lang.String |
getItemId()
Retrieves the ID of the folder to be modified.
|
java.lang.Boolean |
getSearchSubFolders()
Retrieves a Boolean value indicating whether the search subfolders value is to be supplied at runtime.
|
void |
setExcludeFromQuery(java.lang.Boolean exclude)
Excludes from the query one or more folders specified in the search template
by setting the value of the ExcludeFromQuery property.
|
void |
setFolder(Folder folder)
Specifies a folder to be available at runtime.
|
void |
setItemId(java.lang.String itemId)
Specifies the ID of a folder in the search template to be modified or excluded, or the GUID of a new folder to
be added to the search.
|
void |
setSearchSubFolders(java.lang.Boolean searchSubFolders)
Specifies whether subfolders of the folder are to be included in the search.
|
public java.lang.Boolean getExcludeFromQuery()
Boolean
value of false
or null
if no
folders in the search template are to be excluded at runtime; true
if
one or more folders is to be excluded at runtime.public void setExcludeFromQuery(java.lang.Boolean exclude)
false
.
To exclude a folder, set this property value to true
and add the folder or folders
exclusion to the search template parameters using SearchTemplateParameters.setFolders(java.util.List)
.
exclude
- A Boolean
value. If false
or null
, no folders
in the search template are excluded, if true
, the folder or folders to be
excluded must be specified using SearchTemplateParameters.setFolders
. Any folders
excluded will not be available at runtime.public Folder getFolder()
setFolder
method.Folder
object for the folder to be available at runtime.public void setFolder(Folder folder)
If null, no change is made to the search template.
folder
- A Folder
object either for an existing folder in the search template, or for a
new folder to be added to the query.public java.lang.Boolean getSearchSubFolders()
setSearchSubFolders
method.Boolean
value of false
or null
if the
search subfolders value in the search template is to be used; true
if the search subfolders
value is to be supplied at runtime.public void setSearchSubFolders(java.lang.Boolean searchSubFolders)
If a new folder item is being added to the query, this property is required.
searchSubFolders
- A Boolean
value. If false
or null
, the
search subfolders value in the search template is used, if true
, subfolders will be included
in the search.public java.lang.String getItemId()
setItemId
.String
containing the ID of the folder to be modified.public void setItemId(java.lang.String itemId)
Note: If a new folder is being added to the search, all properties for this instance must be set or an exception will be thrown.
itemId
- A String
containing the ID of a folder in the search template, or the GUID of a new
new folder to be added to the search.© Copyright IBM Corporation 2006, 2015. All rights reserved.