public class SearchTemplateSubclass
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 |
---|
SearchTemplateSubclass() |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getExcludeFromQuery()
Retrieves a Boolean value indicating whether any subclasses in the search template are to
be excluded at runtime.
|
java.lang.Boolean |
getIncludeSubclasses()
Retrieves a Boolean value indicating that a class specified in the included subclasses property (the
includesubclasses element) in the search template is to be overridden by a subclass, or a new class added
to the include subclasses property.
|
java.lang.String |
getItemId()
Retrieves the GUID of the subclass to be to be modified, excluded or added for the search.
|
java.lang.String |
getSymbolicName()
Retrieves the symbolic name of the subclass to be to be modified, excluded or added for the search.
|
void |
setExcludeFromQuery(java.lang.Boolean exclude)
Excludes from the query one or more subclasses specified in the search template.
|
void |
setIncludeSubclasses(java.lang.Boolean includeSubclasses)
Indicates that subclasses are to be included in the search.
|
void |
setItemId(java.lang.String itemId)
Specifies the GUID of the subclass to be to be modified, excluded or added for the search.
|
void |
setSymbolicName(java.lang.String symname)
Specifies the symbolic name of the subclass to be to be modified, excluded or added for the search.
|
public java.lang.Boolean getExcludeFromQuery()
Boolean
value of false
or null
if no
subclasses in the search template are to be excluded at runtime; true
if
one or more subclasses is to be excluded at runtime.public void setExcludeFromQuery(java.lang.Boolean exclude)
false
.
To exclude a subclass, set this property value to true
and add the subclass or subclasses
exclusion to the search template parameters using SearchTemplateParameters.setFolders(java.util.List)
.
exclude
- A Boolean
value. If false
or null
, no subclasses
in the search template are excluded, if true
, the subclass or subclasses to be
excluded must be specified using SearchTemplateParameters.setFolders
. Any subclasses
excluded will not be available at runtime.public java.lang.Boolean getIncludeSubclasses()
setItemId
).Boolean
value of false
or null
if the included
subclasses property in the search template is to be used unchanged; true
if
an existing subclass is to be overridden, or a new subclass added.public void setIncludeSubclasses(java.lang.Boolean includeSubclasses)
includeSubclasses
- A Boolean
value of false
or null
if the included
subclasses property in the search template is to be used unchanged; true
if
an subclasses are to be included in the search.public java.lang.String getItemId()
setItemId
method.String
containing the GUID for the subclass to be modified, excluded or added for
the search.public void setItemId(java.lang.String itemId)
itemId
- A String
containing the GUID for the subclass to be modified, excluded or added
for the search.public java.lang.String getSymbolicName()
setSymbolicName
method.String
containing the symbolic name of the subclass to be modified, excluded or
added for the search.public void setSymbolicName(java.lang.String symname)
symname
- A String
containing the symbolic name of the subclass to be modified, excluded or
added for the search.© Copyright IBM Corporation 2006, 2015. All rights reserved.