com.stellent.cis.client.api.sis.search
Interface ISISSearchPrompt

All Superinterfaces:
ICISObject, ICISSearchPrompt, ISISObject, java.io.Serializable

public interface ISISSearchPrompt
extends ICISSearchPrompt, ISISObject


Field Summary
 
Fields inherited from interface com.stellent.cis.client.api.common.ICISObject
FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM
 
Fields inherited from interface com.stellent.cis.client.api.sis.ISISObject
OPERATOR_ADVSEARCH, OPERATOR_ALLVALUES, OPERATOR_AND, OPERATOR_BEGINSWITH, OPERATOR_CONTAINS, OPERATOR_ENDSWITH, OPERATOR_EQUAL, OPERATOR_EXACTPHRASE, OPERATOR_GREATERTHAN, OPERATOR_GREATERTHANEQUAL, OPERATOR_IN, OPERATOR_LESSTHAN, OPERATOR_LESSTHANEQUAL, OPERATOR_LIKE, OPERATOR_NOTBEGINSWITH, OPERATOR_NOTCONTAINS, OPERATOR_NOTENDSWITH, OPERATOR_NOTEQUAL, OPERATOR_NOTIN, OPERATOR_NOTLIKE, OPERATOR_OR, OPERATOR_SEARCH
 
Fields inherited from interface com.stellent.cis.client.api.common.ICISObject
FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM
 
Method Summary
 java.lang.String getDisplayMask()
           
 int getDisplayStyle()
           
 java.lang.String getOperatorStr()
           
 java.lang.String getPickListName()
           
 boolean isPickList()
           
 boolean isUseValue()
           
 void setDisplayMask(java.lang.String newDisplayMask)
           
 void setDisplayStyle(int newDisplayStyle)
           
 void setUseValue(boolean newUseValue)
           
 
Methods inherited from interface com.stellent.cis.client.api.common.search.ICISSearchPrompt
getDisplayText, getFieldID, getFieldType, getOperator, getOperators, getUserInput, isRequired, setUserInput
 
Methods inherited from interface com.stellent.cis.client.api.common.ICISObject
getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty
 
Methods inherited from interface com.stellent.cis.client.api.sis.ISISObject
getErrorMessage, getObjectVersion, getSourceObject, getSourceObject, hasError
 
Methods inherited from interface com.stellent.cis.client.api.common.ICISObject
getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty
 

Method Detail

isPickList

boolean isPickList()
Returns:
Specifies whether or not the pick list values can be used to enter the prompt information for the profile, as configured within the PromptCriterion.

getPickListName

java.lang.String getPickListName()
Returns:
The name of the associate picklist, if any.

getOperatorStr

java.lang.String getOperatorStr()
Returns:
The string representation of the operator value.

getDisplayStyle

int getDisplayStyle()
Returns:
The display style

setDisplayStyle

void setDisplayStyle(int newDisplayStyle)
Parameters:
newDisplayStyle - The display style to set

getDisplayMask

java.lang.String getDisplayMask()
Returns:
The display mask

setDisplayMask

void setDisplayMask(java.lang.String newDisplayMask)
Parameters:
newDisplayMask - The display mask to set

isUseValue

boolean isUseValue()
Returns:
true to use the value from ICISSearchPrompt.getUserInput()

setUseValue

void setUseValue(boolean newUseValue)
Parameters:
newUseValue - Set to true to use the value from ICISSearchPrompt.getUserInput()