public class SearchTemplateWhereProperty
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 |
---|
SearchTemplateWhereProperty() |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getExcludeFromQuery()
Retrieves a Boolean value indicating whether any Where properties (whereprop items) in the search template
are to be excluded.
|
java.lang.String |
getItemId()
Retrieves the ID of the Where property to be modified or excluded.
|
java.lang.String |
getLiteral()
Retrieves the Where property literal operand that is to be used for the search.
|
void |
setExcludeFromQuery(java.lang.Boolean exclude)
Excludes from the search one or more Where properties specified in the search template.
|
void |
setItemId(java.lang.String itemId)
Specifies the ID of a Where property in the search template to be modified or excluded.
|
void |
setLiteral(java.lang.String literal)
Specifies the Where property literal operand that is to be used for the search.
|
public java.lang.Boolean getExcludeFromQuery()
Boolean
value of false
or null
if no
Where properties in the search template are to be excluded at runtime; true
if
one or more Where properties are to be excluded.public void setExcludeFromQuery(java.lang.Boolean exclude)
false
.
To exclude a Where properties, set this property value to true
and add the Where properties
exclusion to the search template parameters using the SearchTemplateParameters.setWhereProperties(java.util.List)
method.
exclude
- A Boolean
value. If false
or null
, no Where properties
in the search template are excluded, if true
, the Where properties to be
excluded must be specified using SearchTemplateParameters.setWhereProperties
. Any Where properties
excluded will not be available at runtime.public java.lang.String getItemId()
setItemId
.String
containing the ID of the Where property to be modified or excluded.public void setItemId(java.lang.String itemId)
New Where properties cannot be added to a query, so the itemId
value must match the ID of
a Where property (whereprop item) existing in the search template.
itemId
- A String
containing the ID of a Where property in the search template to be modified
or excluded.public java.lang.String getLiteral()
setLiteral
method.String
containing the Where property literal operand to be used for the search.public void setLiteral(java.lang.String literal)
literal
- A String
containing the Where property literal operand to be used for the
search.© Copyright IBM Corporation 2006, 2015. All rights reserved.