com.stellent.cis.client.api.sis.process
Interface ISISProfilePrompt

All Superinterfaces:

ICISObject, ISISObject, java.io.Serializable

public interface ISISProfilePrompt
extends ISISObject

Field Summary

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.util.List	getAvailableOperators()
java.lang.String	getDisplayText()
java.lang.String	getDistinctListName()
int	getFieldID()
int	getFieldType()
ISISProcessOperator	getOperator()
java.lang.String	getPickListName()
java.lang.String	getUserInput()
boolean	hasPickList()
boolean	isRequired()
void	setUserInput(java.lang.String input)
boolean	useDistinctList()

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

getFieldID

int getFieldID()

Returns:

Uniquely identifies a field within a given Package.

getFieldType

int getFieldType()

Returns:

This property is identifies the type of the FieldDefinition that has been associated with the PromptCriterion

getDisplayText

java.lang.String getDisplayText()

Returns:

Represents the text used to identify what field information is needed to be entered.

getOperator

ISISProcessOperator getOperator()

Returns:

Object containing information about the operator for this prompt field.

getAvailableOperators

java.util.List getAvailableOperators()

Returns:

List containing all available operators for this prompt field ISISProcessOperator

isRequired

boolean isRequired()

Returns:

Specifies whether or not the prompt information is required in order to execute the profile, as configured within the PromptCriterion.

hasPickList

boolean hasPickList()

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.

useDistinctList

boolean useDistinctList()

Returns:

Specifies whether or not the distinct list values can be used to enter the prompt information for the profile, as configured within the PromptCriterion.

getDistinctListName

java.lang.String getDistinctListName()

Returns:

The name of the associated Distinct List.

getPickListName

java.lang.String getPickListName()

Returns:

The name of the associated pick list, if any.

getUserInput

java.lang.String getUserInput()

Returns:

The value of the prompt field.

setUserInput

void setUserInput(java.lang.String input)

Parameters:

input - The user specified input for this prompt field.