|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
public static final ArgumentType ENUM
public static final ArgumentType FILE
public static final ArgumentType MULTI_LINE
public static final ArgumentType SINGLE_LINE
Method Detail |
public java.lang.String getCaption()
Typically set by the MasterService
.
public java.lang.String getComment()
public java.lang.String getName()
Typically defined by the Adapter
.
public java.lang.String[] getOptions()
ArgumentType.ENUM
public ArgumentType getType()
public java.lang.Boolean getUsageUser()
Boolean.TRUE
if this argument is a target of end-user customization, Boolean.FALSE
if not or null if undefined.public java.lang.String getValue()
public java.lang.String[] getValues()
public boolean isUsageUser()
public void setCaption(java.lang.String caption)
Typically set by the MasterService
.
caption
- the caption.public void setComment(java.lang.String comment)
Typically set by the Adapter
.
comment
- the comment.public void setName(java.lang.String name)
name
- the new name.public void setOptions(java.lang.String[] options)
options
- the possible values of this argument as an array of String
.ArgumentType.ENUM
public void setType(ArgumentType type)
Typically set by the Adapter
.
type
- one of SINGLE_LINE, MULTI_LINE or ENUM.public void setUsageUser(boolean user)
user
- true
if this argument is a target of end-user customization, false
if not.public void setUsageUser(java.lang.Boolean user)
user
- Boolean.TRUE
if this argument is a target of end-user customization, Boolean.FALSE
if not, or null if undefined.public void setValue(java.lang.String value)
value
- the value.public void setValues(java.lang.String[] values)
values
- an array of values.
|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |