com.filenet.api.query

Class SearchTemplateWhereProperty

java.lang.Object

com.filenet.api.query.SearchTemplateWhereProperty

All Implemented Interfaces:

java.io.Serializable

public class SearchTemplateWhereProperty
extends java.lang.Object
implements java.io.Serializable

Identifies the Where properties in the search template that can be modified or excluded for runtime purposes, and enables you to choose whether the search template settings or the property values specified for this class are to be used for the search.

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
SearchTemplateWhereProperty()

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchTemplateWhereProperty

public SearchTemplateWhereProperty()

Method Detail

getExcludeFromQuery

public java.lang.Boolean getExcludeFromQuery()

Retrieves a Boolean value indicating whether any Where properties (whereprop items) in the search template are to be excluded.

Returns:

A 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.

setExcludeFromQuery

public void setExcludeFromQuery(java.lang.Boolean exclude)

Excludes from the search one or more Where properties specified in the search template. Defaults to 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.

Parameters:

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.

getItemId

public java.lang.String getItemId()

Retrieves the ID of the Where property to be modified or excluded. This Where property is specified using the setItemId.

Returns:

A String containing the ID of the Where property to be modified or excluded.

setItemId

public void setItemId(java.lang.String itemId)

Specifies the ID of a Where property in the search template to be modified or excluded. This is a required property.

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.

Parameters:

itemId - A String containing the ID of a Where property in the search template to be modified or excluded.

getLiteral

public java.lang.String getLiteral()

Retrieves the Where property literal operand that is to be used for the search. The Where property literal operand is specified using the setLiteral method.

Returns:

A String containing the Where property literal operand to be used for the search.

setLiteral

public void setLiteral(java.lang.String literal)

Specifies the Where property literal operand that is to be used for the search. The Where property literal operand specified will override the literal operand used for the Where property in the search template. If null, no change is made to the search template data.

Parameters:

literal - A String containing the Where property literal operand to be used for the search.