com.stellent.cis.client.api.sis.search
Interface ISISAdhocPrompt
- All Superinterfaces:
- ICISObject, ISISObject, java.io.Serializable
public interface ISISAdhocPrompt
- extends ISISObject
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 |
getName
java.lang.String getName()
- Returns:
- The name of the prompt
getType
java.lang.String getType()
- Returns:
- The type of the field.
isIncludeInResults
boolean isIncludeInResults()
- Returns:
- Defines if the field should be included in the search results.
This value is defaulted to True. Set it to False to not include a field in the results set.
setIncludeInResults
void setIncludeInResults(boolean includeInResults)
- Parameters:
includeInResults
- Defines if the field should be included in the search results.
This value is defaulted to True. Set it to False to not include a field in the results set.
getUserInput
java.lang.String getUserInput()
- Returns:
- The value for the comparison.
setUserInput
void setUserInput(java.lang.String leftOperand)
- Parameters:
leftOperand
- The value for the comparison.
getSecondaryInput
java.lang.String getSecondaryInput()
- Returns:
- Used as the second value in comparisons requiring one (i.e. between).
setSecondaryInput
void setSecondaryInput(java.lang.String rightOperand)
- Parameters:
rightOperand
- Used as the second value in comparisons requiring one (i.e. between).
getComparisonOperator
ISISComparisonOperator getComparisonOperator()
- Returns:
- The comparison operator that should be used to combine the prompt comparison.
Use one of the comparisonOperators types and set the type property on this object.
This defaults to NOP which is a value of -1.
setComparisonoperator
void setComparisonoperator(ISISComparisonOperator comparisonOperator)
- Parameters:
comparisonOperator
- The comparison operator that should be used to combine the prompt comparison.
Use one of the comparisonOperators types and set the type property on this object.
This defaults to NOP which is a value of -1.
setComparisonoperator
void setComparisonoperator(int type)
- Parameters:
type
- The type of comparison operator to use for this prompt.
getOptionList
ISISOptionList getOptionList()
- Returns:
- An object describing the option list for this field.