com.filenet.api.query
Class SearchTemplateFolder
- java.lang.Object
-
- com.filenet.api.query.SearchTemplateFolder
-
- All Implemented Interfaces:
- java.io.Serializable
public class SearchTemplateFolder extends java.lang.Object implements java.io.Serializable
Identifies the folder in a search template that is to be modified or excluded, or a new folder that is to be added to the search. Methods are provided to supply new values to a folder being modified.The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data.
- See Also:
SearchTemplateParameters
, Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description SearchTemplateFolder()
-
Method Summary
Methods 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.
-
-
-
Method Detail
-
getExcludeFromQuery
public java.lang.Boolean getExcludeFromQuery()
Retrieves a Boolean value indicating whether any folders in the search template are to be excluded at runtime.- Returns:
- A
Boolean
value offalse
ornull
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.
-
setExcludeFromQuery
public 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. Defaults tofalse
.To exclude a folder, set this property value to
true
and add the folder or folders exclusion to the search template parameters usingSearchTemplateParameters.setFolders(java.util.List)
.- Parameters:
exclude
- ABoolean
value. Iffalse
ornull
, no folders in the search template are excluded, iftrue
, the folder or folders to be excluded must be specified usingSearchTemplateParameters.setFolders
. Any folders excluded will not be available at runtime.
-
getFolder
public Folder getFolder()
Retrieves the folder to be available at runtime. The folder is specified using thesetFolder
method.- Returns:
- A
Folder
object for the folder to be available at runtime.
-
setFolder
public void setFolder(Folder folder)
Specifies a folder to be available at runtime. The folder specified will override a folder in the search template having the same ID. If a folder is specified that does not exist in the search template, it is assumed to be a new folder that is to be added to the query. All properties for this instance must be specified if a new folder is being added to the query.If null, no change is made to the search template.
- Parameters:
folder
- AFolder
object either for an existing folder in the search template, or for a new folder to be added to the query.
-
getSearchSubFolders
public java.lang.Boolean getSearchSubFolders()
Retrieves a Boolean value indicating whether the search subfolders value is to be supplied at runtime. The search subfolders value is specified using thesetSearchSubFolders
method.- Returns:
- A
Boolean
value offalse
ornull
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.
-
setSearchSubFolders
public void setSearchSubFolders(java.lang.Boolean searchSubFolders)
Specifies whether subfolders of the folder are to be included in the search. The value specified here overrides the search subfolders value in the search template. If null, no change is made to the search template.If a new folder item is being added to the query, this property is required.
- Parameters:
searchSubFolders
- ABoolean
value. Iffalse
ornull
, the search subfolders value in the search template is used, iftrue
, subfolders will be included in the search.
-
getItemId
public java.lang.String getItemId()
Retrieves the ID of the folder to be modified. This folder is specified using thesetItemId
.- Returns:
- A
String
containing the ID of the folder to be modified.
-
setItemId
public 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. This is a required property.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.
- Parameters:
itemId
- AString
containing the ID of a folder in the search template, or the GUID of a new new folder to be added to the search.
-
-