oracle.panama
Interface Argument

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

InitArgument, InputArgument, OutputArgument

public interface Argument

extends java.io.Serializable

Generic Interface for an Argument. An argument is defined and used by the Adapter and can be of one the types Init, Input and Output.

See Also:

ArgumentType

Field Summary

static ArgumentType	ENUM Deprecated.
static ArgumentType	FILE Deprecated. since 102 use definition in the new ArgumentType class instead.
static ArgumentType	MULTI_LINE Deprecated.
static ArgumentType	SINGLE_LINE Deprecated.

Method Summary

java.lang.String	getCaption() Gets the caption.
java.lang.String	getComment() Gets the comment.
java.lang.String	getName() Gets the name.
java.lang.String[]	getOptions() Gets the options.
ArgumentType	getType() Gets the type.
java.lang.Boolean	getUsageUser() Gets the end user usage.
java.lang.String	getValue() Gets the value.
java.lang.String[]	getValues() Returns the values or null if none.
boolean	isUsageUser() Checks if this argument is a target for end-user customization.
void	setCaption(java.lang.String caption) Sets the caption.
void	setComment(java.lang.String comment) Sets the comment.
void	setName(java.lang.String name) Sets the name.
void	setOptions(java.lang.String[] options) Sets the options, this call is only valid if the type is ENUM.
void	setType(ArgumentType type) Sets the type.
void	setUsageUser(boolean user) Sets the user usage.
void	setUsageUser(java.lang.Boolean user) Sets the user usage.
void	setValue(java.lang.String value) Sets the value.
void	setValues(java.lang.String[] values) Sets the values.

Field Detail

ENUM

public static final ArgumentType ENUM

Deprecated.

The enum constant.

FILE

public static final ArgumentType FILE

Deprecated. since 102 use definition in the new ArgumentType class instead.

The file constant.

MULTI_LINE

public static final ArgumentType MULTI_LINE

Deprecated.

The multi line constant.

SINGLE_LINE

public static final ArgumentType SINGLE_LINE

Deprecated.

The single line constant.

Method Detail

getCaption

public java.lang.String getCaption()

Gets the caption.

Typically set by the MasterService.

Returns:

the caption or the name of the argument if not defined.

getComment

public java.lang.String getComment()

Gets the comment.

Returns:

the comment or null if not defined.

getName

public java.lang.String getName()

Gets the name.

Typically defined by the Adapter.

Returns:

the non null unqiue name.

getOptions

public java.lang.String[] getOptions()

Gets the options. Options are used for ENUM arguments, and is just a list of values that this argument can have.

Returns:

the options if the type is ENUM, otherwise null.

See Also:

ArgumentType.ENUM

getType

public ArgumentType getType()

Gets the type.

Returns:

the type, one of SINGLE_LINE, MULTI_LINE or ENUM.

getUsageUser

public java.lang.Boolean getUsageUser()

Gets the end user usage.

Returns:

Boolean.TRUE if this argument is a target of end-user customization, Boolean.FALSE if not or null if undefined.

getValue

public java.lang.String getValue()

Gets the value.

Returns:

the value or null if none.

getValues

public java.lang.String[] getValues()

Returns the values or null if none.

Returns:

an array of values

isUsageUser

public boolean isUsageUser()

Checks if this argument is a target for end-user customization.

Returns:

true of this argument is a target for end-user customization, otherwise false.

setCaption

public void setCaption(java.lang.String caption)

Sets the caption.

Typically set by the MasterService.

Parameters:

caption - the caption.

setComment

public void setComment(java.lang.String comment)

Sets the comment.

Typically set by the Adapter.

Parameters:

comment - the comment.

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - the new name.

setOptions

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

Sets the options, this call is only valid if the type is ENUM.

Parameters:

options - the possible values of this argument as an array of String.

See Also:

ArgumentType.ENUM

setType

public void setType(ArgumentType type)

Sets the type.

Typically set by the Adapter.

Parameters:

type - one of SINGLE_LINE, MULTI_LINE or ENUM.

setUsageUser

public void setUsageUser(boolean user)

Sets the user usage.

Parameters:

user - true if this argument is a target of end-user customization, false if not.

setUsageUser

public void setUsageUser(java.lang.Boolean user)

Sets the user usage.

Parameters:

user - Boolean.TRUE if this argument is a target of end-user customization, Boolean.FALSE if not, or null if undefined.

setValue

public void setValue(java.lang.String value)

Sets the value.

Parameters:

value - the value.

setValues

public void setValues(java.lang.String[] values)

Sets the values.

Parameters:

values - an array of values.