com.ibm.bpe.api
Interface UserInputOption


public interface UserInputOption

Provides for user-defined input options.

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.

This interface supports the selection of a single option from several possible options.


Method Summary
 java.lang.String getDisplayName()
          Deprecated. Returns a display name for the user option.
 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 option.
 boolean getState()
          Deprecated. Denotes whether the user input option is set by the user.
 boolean isComplete()
          Deprecated. States whether a required user input option is specified.
 boolean isRequired()
          Deprecated. States whether the user input option is required.
 boolean isSet()
          Deprecated. States whether the user input option is set.
 void setState(boolean state)
          Deprecated. State that the user input option is set by the user.
 

Method Detail

isComplete

public boolean isComplete()
Deprecated. 
States whether a required user input option is specified.

Returns:
boolean True, if the user input option is specified or not required. False, if the user input options is not specified and required.

isRequired

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

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

isSet

public boolean isSet()
Deprecated. 
States whether the user input option is set.

Returns:
boolean True, if the user input option is set. False, if the user input option is not set.

getDisplayName

public java.lang.String getDisplayName()
Deprecated. 
Returns a display name for the user option.

Returns:
String The display name associated with the user option. 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 option.

Returns:
String The name associated with the user option.

getState

public boolean getState()
Deprecated. 
Denotes whether the user input option is set by the user.

Returns:
boolean True, if the user input option is set by the user. False, if the user input option is not set by the user; if set, it is by default.

setState

public void setState(boolean state)
Deprecated. 
State that the user input option is set by the user.