org.nuclos.api.context

Class InputSpecification

java.lang.Object

org.nuclos.api.context.InputSpecification

All Implemented Interfaces:

java.io.Serializable

public class InputSpecification
extends java.lang.Object
implements java.io.Serializable

Specification of input dialog.

Author:

thomas.schiffmann

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONFIRM_OK_CANCEL Input type to show a ok/cancel dialog.
static int	CONFIRM_YES_NO Input type to show a yes/no dialog.
static int	INPUT_MEMO Input type to show string memo input dialog (with text area and possibility to enter a line break)
static int	INPUT_OPTION Input type to show a select option dialog.
static int	INPUT_VALUE Input type to show string input dialog.
static int	NO Variable value for no.
static int	OK Variable value for ok.
static int	YES Variable value for yes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InputSpecification() for deserialization only
	InputSpecification(int type, java.lang.String key, java.lang.String message) Create a new InputSpecification
	InputSpecification(int type, java.lang.String key, java.lang.String message, java.lang.String title) Create a new InputSpecification

Method Summary

Modifier and Type	Method and Description
boolean	applyForAllMultiEditObjects() internal use only
java.lang.Object	getDefaultOption() Get default option (of available options, only applicable for INPUT_OPTION)
java.lang.String	getKey() Get the variable key/name.
java.lang.String	getMessage() Get the dialog message.
java.lang.Object[]	getOptions() Get available input options, only applicable for INPUT_OPTION.
java.lang.String	getTitle() Get the dialog title.
int	getType() Get input type.
void	setApplyForAllMultiEditObjects(boolean applyForAllMultiEditObjects)
void	setDefaultOption(java.lang.Object defaultOption) Set default option (of available options, only applicable for INPUT_OPTION)
void	setOptions(java.lang.Object[] options) Set available input options, only applicable for INPUT_OPTION.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIRM_YES_NO

public static final int CONFIRM_YES_NO

Input type to show a yes/no dialog.

See Also:

Constant Field Values

CONFIRM_OK_CANCEL

public static final int CONFIRM_OK_CANCEL

Input type to show a ok/cancel dialog. If the user choosed cancel, the request won't execute again.

See Also:

Constant Field Values

OK

public static final int OK

Variable value for ok.

See Also:

Constant Field Values

YES

public static final int YES

Variable value for yes.

See Also:

Constant Field Values

NO

public static final int NO

Variable value for no.

See Also:

Constant Field Values

INPUT_VALUE

public static final int INPUT_VALUE

Input type to show string input dialog.

See Also:

Constant Field Values

INPUT_MEMO

public static final int INPUT_MEMO

Input type to show string memo input dialog (with text area and possibility to enter a line break)

See Also:

Constant Field Values

INPUT_OPTION

public static final int INPUT_OPTION

Input type to show a select option dialog.

See Also:

Constant Field Values

Constructor Detail

InputSpecification

protected InputSpecification()

for deserialization only

InputSpecification

public InputSpecification(int type,
                          java.lang.String key,
                          java.lang.String message)

Create a new InputSpecification

Parameters:

type - Input type (CONFIRM_YES_NO, CONFIRM_OK_CANCEL, INPUT_VALUE or INPUT_OPTION)

key - Variable key (to obtain the value)

message - Dialog message

InputSpecification

public InputSpecification(int type,
                          java.lang.String key,
                          java.lang.String message,
                          java.lang.String title)

Create a new InputSpecification

Parameters:

type - Input type (CONFIRM_YES_NO, CONFIRM_OK_CANCEL, INPUT_VALUE or INPUT_OPTION)

key - Variable key (to obtain the value)

message - Dialog message

title - Dialog title

Method Detail

getType

public int getType()

Get input type.

Returns:

Input type

getKey

public java.lang.String getKey()

Get the variable key/name.

Returns:

Variable key/name

getMessage

public java.lang.String getMessage()

Get the dialog message.

Returns:

Dialog message

getTitle

public java.lang.String getTitle()

Get the dialog title.

Returns:

Dialog title

getOptions

public java.lang.Object[] getOptions()

Get available input options, only applicable for INPUT_OPTION.

Returns:

Input options

setOptions

public void setOptions(java.lang.Object[] options)

Set available input options, only applicable for INPUT_OPTION.

Parameters:

options - Available input options

getDefaultOption

public java.lang.Object getDefaultOption()

Get default option (of available options, only applicable for INPUT_OPTION)

Returns:

Default option.

setDefaultOption

public void setDefaultOption(java.lang.Object defaultOption)

Set default option (of available options, only applicable for INPUT_OPTION)

Parameters:

defaultOption - Default option

applyForAllMultiEditObjects

public boolean applyForAllMultiEditObjects()

internal use only

Returns:

applyForAllMultiEditObjects

setApplyForAllMultiEditObjects

public void setApplyForAllMultiEditObjects(boolean applyForAllMultiEditObjects)

Parameters:

applyForAllMultiEditObjects - false (default): One input question for every object during a multi edit. true: The client is instructed to ask for the input only once. You have to choose a general key for your input to work as expected, no object specific data within the key.