com.ibm.bpe.api
Interface UserInput

All Superinterfaces:
java.io.Serializable

public interface UserInput
extends java.io.Serializable

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:

  1. A decision that is to be made from several possible options.
  2. A task list that allows multiple options to be selected.

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

TYPE_SINGLESELECT

public static final short TYPE_SINGLESELECT
Deprecated. 
Denotes that a decision is to be made. A single option can be selected out of several possible.

See Also:
Constant Field Values

TYPE_MULTISELECT

public static final short TYPE_MULTISELECT
Deprecated. 
Denotes that multiple options can be selected. For example, in a tasklist multiple entries can be checked to remember work progress.

See Also:
Constant Field Values
Method Detail

isComplete

public boolean isComplete()
Deprecated. 
States whether all required user input options are specified.

Returns:
boolean True, if all required user input options are specified. False, if a required user input option is not specified.

isRequired

public boolean isRequired()
Deprecated. 
States whether user input is required.

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.

Returns:
boolean True, if user input is required. False, if user input is not required.

getDisplayName

public java.lang.String getDisplayName()
Deprecated. 
Returns a name associated with the user's options that can be displayed.

Returns:
String The display name associated with the user's options. If there is no display name, a null string is returned.

getFailureText

public java.lang.String getFailureText()
Deprecated. 
Provides the text to be shown when the user input contains errors.

Returns:
String The text to be shown when the user input contains errors.

getName

public java.lang.String getName()
Deprecated. 
Returns the name associated with the user's options.

Returns:
String The name associated with the user's options.

getOptions

public UserInputOption[] getOptions()
Deprecated. 
Returns a list of options specific to the calling user.

Returns:
UserInputOption[] An array of user-specified options. If user options are not found, an empty array is returned.

getType

public short getType()
Deprecated. 
Returns the user input type.

Returns:
short TYPE_SINGLESELECT denotes that a decision is to be made. A single option can be selected out of several possible. TYPE_MULTISELECT denotes that multiple options can be selected. For example, in a task list multiple entries can be checked to remember work progress.