oracle.panama
Interface Arguments

All Superinterfaces:

oracle.panama.core.csc.CSC, InputValueMap, java.io.Serializable

All Known Subinterfaces:

OutputArguments

public interface Arguments

extends oracle.panama.core.csc.CSC, InputValueMap

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

ROOT_ELEMENT

public static final java.lang.String ROOT_ELEMENT

The Arguments XML Element tag name.

See Also:

Constant Field Values

USAGE_USER

public static final java.lang.String USAGE_USER

Deprecated. This symbol is not needed when we can use a boolean value instead.

The USAGE_USER Symbol, if the "usage" attribute is set to this value, then this parameter is a target for en-user customization.

See Also:

Constant Field Values

Method Detail

renameInput

public void renameInput(java.lang.String oldName,
                        java.lang.String newName)

Deprecated.

Rename an Argument. Needed by the Service Designer.

Parameters:

oldName - the new name.

newName - the new name.

removeInput

public void removeInput(java.lang.String name)

Deprecated.

Delete an Argument. Needed by the Service Designer.

Parameters:

name - name of the element to delete.

rename

public void rename(java.lang.String oldName,
                   java.lang.String newName)

Rename an argument. Needed by the Service Designer.

Parameters:

oldName - the new name.

newName - the new name.

createInput

public InputArgument createInput(java.lang.String name)
                          throws PanamaRuntimeException

Create an input argument.

Parameters:

name - the unique name of the input argument.

Returns:

the created input argument.

Throws:

PanamaRuntimeException - when the argument already exists.

createInput

public InputArgument createInput(java.lang.String name,
                                 java.lang.String caption,
                                 java.lang.String value,
                                 boolean usageUser)
                          throws PanamaRuntimeException

Create an Input argument.

Parameters:

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.

Returns:

the created input argument.

Throws:

PanamaRuntimeException - when the argument already exists.

getInputCaption

public java.lang.String getInputCaption(java.lang.String name)

Deprecated.

Get the caption for a given input name.

Parameters:

name - the unique name for an argument.

Returns:

the caption or null if none exists.

setInputCaption

public void setInputCaption(java.lang.String name,
                            java.lang.String caption)

Deprecated.

Set the caption for a given input name.

Parameters:

name - the unique name of an input argument.

caption - the display text if this argument.

createOutputFilter

public OutputArgument createOutputFilter(java.lang.String outputName)
                                  throws PanamaException

Deprecated. no replacement

Create an Output filtering Argument. This can be used by the Adapter to filter it's output, and is typically set by an asynchronous Job.

Parameters:

outputName - the name of the ouput argument.

Returns:

an output argument object to set filtering conditions on.

Throws:

PanamaException - when the filter alrady exists.

See Also:

OutputArgument

mergeInputs

public Arguments mergeInputs(Arguments source)

Deprecated. Replaced by mergeArguments()

Merge two Arguments into one, don't change the existing objects.

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.

Parameters:

source - the Arguments that overrides the existing Arguments.

Returns:

the new Arguments datatype with the merged arguments.

mergeOutputs

public Arguments mergeOutputs(Arguments source)

Deprecated. no replacement

Merge two output arguments into one.

Parameters:

source - the source arguments.

Returns:

the new merged arguments.

mergeArguments

public Arguments mergeArguments(Arguments source)

Merge two Arguments into one, don't change the existing objects.

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.

Parameters:

source - the source arguments that overrides the existing.

Returns:

the new arguments datatype with the merged arguments.

setInputValue

public void setInputValue(java.lang.String name,
                          java.lang.String value)

Sets the value of an argument. If the argument doesn't exists the a new is created.

Specified by:

setInputValue in interface InputValueMap

Parameters:

name - the name of the argument.

value - the value.

See Also:

Argument.setValue()

setInputValues

public void setInputValues(java.lang.String name,
                           java.lang.String[] values)

Sets the values of an argument. If the argument doesn't exists the a new is created.

Specified by:

setInputValues in interface InputValueMap

Parameters:

name - the name of the argument.

values - string array containing the values.

See Also:

Argument.setValues()

getInputValue

public java.lang.String getInputValue(java.lang.String name)

Gets the value of an argument by the argument name.

Specified by:

getInputValue in interface InputValueMap

Parameters:

name - the argument name.

Returns:

the value of or null if no such argument or if the value is undefined.

See Also:

Argument.getValue()

getInputValues

public java.lang.String[] getInputValues(java.lang.String name)

Gets the values of an argument by the argument name.

Specified by:

getInputValues in interface InputValueMap

Parameters:

name - the argument name.

Returns:

the values of or null if no such argument or if the value is undefined.

See Also:

Argument.getValues()

getInputNames

public java.util.Enumeration getInputNames()

Return an Enumeration of all input argument names.

Returns:

all input names as an Enumeration of String.

getUserInputNames

public java.util.Enumeration getUserInputNames()

Returns:

all input arguments which are targeted for end-user customization as an Enumeration of String.

getInput

public InputArgument getInput(java.lang.String name)

Get an existing input argument.

Parameters:

name - the non null Argument name.

Returns:

the input argument as an Object.

See Also:

InputArgument

getInputs

public java.util.Enumeration getInputs()

Returns:

All inputs as an Enumeration of InputArgument Objects.

See Also:

InputArgument

getArguments

public java.util.Enumeration getArguments()

Returns:

All inputs as an Enumeration of InputArgument Objects.

See Also:

InputArgument

getUserInputs

public java.util.Enumeration getUserInputs()

Returns:

all Inputs the end-user can customize, as an Enumeration of InputArgument Objects.

See Also:

InputArgument

getOutputFilter

public OutputArgument getOutputFilter(java.lang.String outputName)

Deprecated. no replacement

Get an Ouput Filtering Argument.

Returns:

the OuputArgument Object or null if no such exists.

See Also:

OutputArgument

getOutputFilters

public java.util.Enumeration getOutputFilters()

Deprecated. no replacement

Get all Output Argument filters.

Returns:

An enumeration of OutputArgument or null if none exists.

See Also:

OutputArgument

hasOutputFilters

public boolean hasOutputFilters()

Deprecated. no replacement

Returns:

true if this Arguments includes filtering arguments, otherwise false.

removeArgument

public void removeArgument(java.lang.String name)

Delete an Argument. Needed by the Service Designer.

Parameters:

name - name of the element to delete.

getArgument

public Argument getArgument(java.lang.String name)

Gets an Argument, regardless of type. Needed by the Service Designer.

Parameters:

name - name of the argument to get.