|
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 |
The Arguments interface. The datatype behind is just a collection of Adapter Arguments
.
The Arguments
datatype handles Init, Input and Filtering arguments, where filtering arguments are one or more OutputArgument
with specified filtering conditions.
The Service knows which parameters that are related to the Input, Output and Init parameters of an Adapter. But the Arguments structure is not aware of this, and therefore an Argument name must be unqiue within the complete Arguments
context for one combination of a Service and an Adapter.
Each Adapter
defines it's Arguments
, and the Services can set caption and values on these arguments. An Argument
value can be overidden by other Services in the service chain, and therefore this datatype supports mergning of Arguments
.
Field Summary | |
static java.lang.String |
ROOT_ELEMENT The Arguments XML Element tag name. |
static java.lang.String |
USAGE_USER Deprecated. This symbol is not needed when we can use a boolean value instead. |
Method Summary | |
InputArgument |
createInput(java.lang.String name) Create an input argument. |
InputArgument |
createInput(java.lang.String name, java.lang.String caption, java.lang.String value, boolean usageUser) Create an Input argument. |
OutputArgument |
createOutputFilter(java.lang.String outputName) Deprecated. no replacement |
Argument |
getArgument(java.lang.String name) Gets an Argument, regardless of type. |
java.util.Enumeration |
getArguments() |
InputArgument |
getInput(java.lang.String name) Get an existing input argument. |
java.lang.String |
getInputCaption(java.lang.String name) Deprecated. |
java.util.Enumeration |
getInputNames() Return an Enumeration of all input argument names. |
java.util.Enumeration |
getInputs() |
java.lang.String |
getInputValue(java.lang.String name) Gets the value of an argument by the argument name. |
java.lang.String[] |
getInputValues(java.lang.String name) Gets the values of an argument by the argument name. |
OutputArgument |
getOutputFilter(java.lang.String outputName) Deprecated. no replacement |
java.util.Enumeration |
getOutputFilters() Deprecated. no replacement |
java.util.Enumeration |
getUserInputNames() |
java.util.Enumeration |
getUserInputs() |
boolean |
hasOutputFilters() Deprecated. no replacement |
Arguments |
mergeArguments(Arguments source) Merge two Arguments into one, don't change the existing objects. |
Arguments |
mergeInputs(Arguments source) Deprecated. Replaced by mergeArguments() |
Arguments |
mergeOutputs(Arguments source) Deprecated. no replacement |
void |
removeArgument(java.lang.String name) Delete an Argument. |
void |
removeInput(java.lang.String name) Deprecated. |
void |
rename(java.lang.String oldName, java.lang.String newName) Rename an argument. |
void |
renameInput(java.lang.String oldName, java.lang.String newName) Deprecated. |
void |
setInputCaption(java.lang.String name, java.lang.String caption) Deprecated. |
void |
setInputValue(java.lang.String name, java.lang.String value) Sets the value of an argument. |
void |
setInputValues(java.lang.String name, java.lang.String[] values) Sets the values of an argument. |
Methods inherited from interface oracle.panama.core.csc.CSC |
getElement, getElement |
Field Detail |
public static final java.lang.String ROOT_ELEMENT
public static final java.lang.String USAGE_USER
Method Detail |
public InputArgument createInput(java.lang.String name) throws PanamaRuntimeException
name
- the unique name of the input argument.PanamaRuntimeException
- when the argument already exists.public InputArgument createInput(java.lang.String name, java.lang.String caption, java.lang.String value, boolean usageUser) throws PanamaRuntimeException
name
- the unique name of the input argument.caption
- the caption or null.value
- the value or null.usageUser
- true if this argument is a target for end user customization, otherwise false.PanamaRuntimeException
- when the argument already exists.public OutputArgument createOutputFilter(java.lang.String outputName) throws PanamaException
Job
.outputName
- the name of the ouput argument.PanamaException
- when the filter alrady exists.OutputArgument
public Argument getArgument(java.lang.String name)
name
- name of the argument to get.public java.util.Enumeration getArguments()
InputArgument
public InputArgument getInput(java.lang.String name)
name
- the non null Argument name.InputArgument
public java.lang.String getInputCaption(java.lang.String name)
name
- the unique name for an argument.public java.util.Enumeration getInputNames()
String
.public java.util.Enumeration getInputs()
InputArgument
public java.lang.String getInputValue(java.lang.String name)
getInputValue
in interface InputValueMap
name
- the argument name.Argument.getValue()
public java.lang.String[] getInputValues(java.lang.String name)
getInputValues
in interface InputValueMap
name
- the argument name.Argument.getValues()
public OutputArgument getOutputFilter(java.lang.String outputName)
OutputArgument
public java.util.Enumeration getOutputFilters()
OutputArgument
or null if none exists.OutputArgument
public java.util.Enumeration getUserInputNames()
String
.public java.util.Enumeration getUserInputs()
InputArgument
public boolean hasOutputFilters()
Arguments
includes filtering arguments, otherwise false.public Arguments mergeArguments(Arguments source)
This methods overrides the current Arguments
with the one specified. The result is a newly created dataype and the current one's are not a target for modification.
If there is any Filtering arguments in the "source" Arguments these are copied to the new Arguments
datatype.
source
- the source arguments that overrides the existing.public Arguments mergeInputs(Arguments source)
This methods overrides the current Arguments
with the one specified. The result is a newly created dataype and the current one's are not a target for modification.
If there is any Filtering arguments in the "source" Arguments these are copied to the new Arguments
datatype.
source
- the Arguments
that overrides the existing Arguments
.Arguments
datatype with the merged arguments.public Arguments mergeOutputs(Arguments source)
source
- the source arguments.public void removeArgument(java.lang.String name)
name
- name of the element to delete.public void removeInput(java.lang.String name)
name
- name of the element to delete.public void rename(java.lang.String oldName, java.lang.String newName)
oldName
- the new name.newName
- the new name.public void renameInput(java.lang.String oldName, java.lang.String newName)
oldName
- the new name.newName
- the new name.public void setInputCaption(java.lang.String name, java.lang.String caption)
name
- the unique name of an input argument.caption
- the display text if this argument.public void setInputValue(java.lang.String name, java.lang.String value)
setInputValue
in interface InputValueMap
name
- the name of the argument.value
- the value.Argument.setValue(String)
public void setInputValues(java.lang.String name, java.lang.String[] values)
setInputValues
in interface InputValueMap
name
- the name of the argument.values
- string array containing the values.Argument.setValues(String[])
|
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 |