fuego.papi
Class Arguments

java.lang.Object
  fuego.papi.Arguments

All Implemented Interfaces:

Serializable

public class Arguments

extends Object

implements Serializable

Represents the arguments for an ArgumentSet for an Activity.

See Also:

Serialized Form

Field Summary

static String	ACTION Argument ACTION contains the value of the predefined instance variable action.
static String	RESULT Argument RESULT contains the value of the predefined instance variable action.4 The argument value contained in this key is of STRING type.

Method Summary

boolean	containsArgument(String name) Returns if this object contains the specified argument name
static Arguments	create() Create a new Arguments object
static Arguments	create(ArgumentMap arguments) Create a new Arguments object with the values of the specified ArgumentMap.
Object	getArgument(String name) Gets the argument value
Map	getArguments() Gets the all arguments contained this Arguments.
String[]	getArgumentsName() Gets all argument names contained this Arguments.
boolean	getBooleanArgument(String name) Gets the argument value
DynamicObject	getCILArguments() For internal use only.
double	getDoubleArgument(String name) Gets the argument value
DynamicObject	getDynamicObject() Gets the DynamicObject that represent this object
DynamicObject	getDynamicObjectArgument(String name) Gets the argument value
long	getLongArgument(String name) Gets the argument value
Time	getTimeArgument(String name) Gets the argument value
void	putArgument(String name, boolean value) Puts a new argument in this object
void	putArgument(String name, double value) Puts a new argument in this object
void	putArgument(String name, DynamicObject value) Puts a new argument in this object
void	putArgument(String name, long value) Puts a new argument in this object
void	putArgument(String name, Object value) Puts a new argument in this object
void	replaceArguments(DynamicObject arguments) For internal use only.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION

public static final String ACTION

Argument ACTION contains the value of the predefined instance variable action. The argument value contained in this key is of Long type. Possible values : NONE = 0; OK = 1; FAIL = 2; RELEASE = 3 CANCEL = 4; REPEAT = 5; ABORT = 6; BACK = 7; SKIP = 8; NEXT = 9;

See Also:

Constant Field Values

RESULT

public static final String RESULT

Argument RESULT contains the value of the predefined instance variable action.4 The argument value contained in this key is of STRING type.

See Also:

Constant Field Values

Method Detail

create

public static Arguments create()

Create a new Arguments object

create

public static Arguments create(ArgumentMap arguments)

Create a new Arguments object with the values of the specified ArgumentMap.

Parameters:

arguments - ArgumentMap used to create the new Arguments.

Returns:

Arguments created.

getArgument

public Object getArgument(String name)

Gets the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getArguments

public Map getArguments()

Gets the all arguments contained this Arguments.

Returns:

Map with the argument name as the key and the argument value as the value.

getArgumentsName

public String[] getArgumentsName()

Gets all argument names contained this Arguments.

Returns:

array with all argument names contained this Arguments or empty array if this Arguments does not have arguments.

getBooleanArgument

public boolean getBooleanArgument(String name)

Gets the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getCILArguments

public DynamicObject getCILArguments()

For internal use only.

getDoubleArgument

public double getDoubleArgument(String name)

Gets the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getDynamicObject

public DynamicObject getDynamicObject()

Gets the DynamicObject that represent this object

Returns:

DynamicObject which represents this object

See Also:

DynamicObject

getDynamicObjectArgument

public DynamicObject getDynamicObjectArgument(String name)

Gets the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getLongArgument

public long getLongArgument(String name)

Gets the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

getTimeArgument

public Time getTimeArgument(String name)

Gets the argument value

Parameters:

name - Name of the argument

Returns:

Argument value

Throws:

InvalidArgumentType

See Also:

Time

containsArgument

public boolean containsArgument(String name)

Returns if this object contains the specified argument name

Parameters:

name - argument name to check.

Returns:

true if this object contains the argument name or false if not.

putArgument

public void putArgument(String name,
                        boolean value)

Puts a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

putArgument

public void putArgument(String name,
                        long value)

Puts a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

putArgument

public void putArgument(String name,
                        double value)

Puts a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

putArgument

public void putArgument(String name,
                        DynamicObject value)

Puts a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

putArgument

public void putArgument(String name,
                        Object value)

Puts a new argument in this object

Parameters:

name - Name of the argument

value - Value of the argument

replaceArguments

public void replaceArguments(DynamicObject arguments)

For internal use only.