|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface provides for user-defined input.
In people-based processes, users are often requested to make a decision based on predefined options. The decision is then used to control the further process of control.
The following types of user input are supported:
User input can be required. When a person activity is to be completed, the server checks whether all the required user input is provided. If not, completion is rejected.
Field Summary | |
---|---|
static short |
TYPE_MULTISELECT
Deprecated. Denotes that multiple options can be selected. |
static short |
TYPE_SINGLESELECT
Deprecated. Denotes that a decision is to be made. |
Method Summary | |
---|---|
java.lang.String |
getDisplayName()
Deprecated. Returns a name associated with the user's options that can be displayed. |
java.lang.String |
getFailureText()
Deprecated. Provides the text to be shown when the user input contains errors. |
java.lang.String |
getName()
Deprecated. Returns the name associated with the user's options. |
UserInputOption[] |
getOptions()
Deprecated. Returns a list of options specific to the calling user. |
short |
getType()
Deprecated. Returns the user input type. |
boolean |
isComplete()
Deprecated. States whether all required user input options are specified. |
boolean |
isRequired()
Deprecated. States whether user input is required. |
Field Detail |
public static final short TYPE_SINGLESELECT
public static final short TYPE_MULTISELECT
Method Detail |
public boolean isComplete()
public boolean isRequired()
If required and the user input type is TYPE_SINGLESELECT, then the user input as such is required. If required and the user input type is TYPE_MULTISELECT, then at least one of the user input options must be set.
public java.lang.String getDisplayName()
public java.lang.String getFailureText()
public java.lang.String getName()
public UserInputOption[] getOptions()
public short getType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |