com.stellent.cis.client.api.common.search
Interface ICISSearchPrompt

All Superinterfaces:

ICISObject, java.io.Serializable

All Known Subinterfaces:

ISISSearchPrompt

public interface ICISSearchPrompt
extends ICISObject

Field Summary

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

java.lang.String	getDisplayText()
java.lang.String	getFieldID()
int	getFieldType()
int	getOperator()
java.lang.String	getOperators()
java.lang.Object	getUserInput()
boolean	isRequired()
void	setUserInput(java.lang.Object newValue)

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Method Detail

getFieldID

java.lang.String getFieldID()

Returns:

String that corresponds to a property descriptor name.

getFieldType

int getFieldType()

Returns:

The type of field (string, number, date, etc).

getDisplayText

java.lang.String getDisplayText()

Returns:

The text to display along with input.

getOperators

java.lang.String getOperators()

Returns:

A comma delimited list of available operators for this prompt.

getOperator

int getOperator()

Returns:

A number representing current operator.

isRequired

boolean isRequired()

Returns:

Whether or not input is required for this prompt.

getUserInput

java.lang.Object getUserInput()

Returns:

The user input associated with this prompt.

setUserInput

void setUserInput(java.lang.Object newValue)

Parameters:

newValue - Sets the value for this prompt.