public class SearchTemplateSelectProperty
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 |
---|
SearchTemplateSelectProperty() |
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
getExcludeFromQuery()
Retrieve the merge data ExcludeFromQuery.
|
java.lang.String |
getItemId()
Retrieve the merge data ItemId.
|
java.lang.Integer |
getSortLevel()
Retrieve the merge data SortLevel.
|
SortOrder |
getSortOrder()
Retrieve the merge data SortOrder.
|
java.lang.String |
getSymbolicName()
Retrieve the merge data selectprop symbolic name.
|
void |
setExcludeFromQuery(java.lang.Boolean exclude)
Set this property to TRUE and add to
SearchTemplateParameters to exclude an existing item from query. |
void |
setItemId(java.lang.String itemId)
Set this property match an existing selectprop item in the Search Template for modification or exclusion,
or a unique value to add a new selectprop item to the query.
|
void |
setSortLevel(java.lang.Integer sortLevel)
Set this property to override existing selectprop sort level in the Search Template, or
provide a sort level for a new selectprop item being added to the query.
|
void |
setSortOrder(SortOrder sortOrder)
Set this property to override existing selectprop sort order in the Search Template, or
provide a sort order for a new selectprop item being added to the query.
|
void |
setSymbolicName(java.lang.String symname)
Set this property to override existing selectprop symbolic name in the Search Template, or
provide a symbolic name for a new selectprop item being added to the query.
|
public java.lang.Boolean getExcludeFromQuery()
public void setExcludeFromQuery(java.lang.Boolean exclude)
SearchTemplateParameters
to exclude an existing item from query.
Default value is FALSEexclude
- A Boolean
instance; if TRUE, excludes existing item from query.public java.lang.String getSymbolicName()
public void setSymbolicName(java.lang.String symname)
symname
- A String
instance, the symbolic name for a subclass.public java.lang.Integer getSortLevel()
public void setSortLevel(java.lang.Integer sortLevel)
sortLevel
- An Integer
instance, specifies a sort level for the selectprop. A value of 0 disables.public SortOrder getSortOrder()
public void setSortOrder(SortOrder sortOrder)
sortOrder
- An SortOrder
instance, specifies a sort order for the selectprop. A value of ASCENDING or DESCENDING.public java.lang.String getItemId()
public void setItemId(java.lang.String itemId)
itemId
- A String
instance, either match existing selectprop item in Search Template,
or unique value when adding a new selectprop item to the query. A required property.© Copyright IBM Corporation 2006, 2015. All rights reserved.