oracle.adfinternal.model.adapter.webservice

Class WSOperation

java.lang.Object

oracle.adfinternal.model.adapter.webservice.WSOperation

public final class WSOperation
extends java.lang.Object

WSOperation encapsulates a Webservice operation at ADF design time.

The WSModel creates instances of WSOperation when parsing the WSDL file with information that can be queried by the data control design time classes to generate the metadata.

Since:

10.1.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESULT

Constructor Summary

Constructors

Constructor and Description
WSOperation(java.lang.String name) Creates an instance of the WSOperation.
WSOperation(java.lang.String name, oracle.webservices.model.Operation operation) Create an instance of this WebService operation.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set	getCollectionSet()
java.lang.String	getDefaultParameterValue(java.lang.String name) Returns the default value of the parameter, null, if default value is not set.
java.util.Map	getDefaultParameterValues()
MethodDef	getMethodDefintion(StructureDef dcParent) Create the JSR227 MethodDefinition for this operation.
java.lang.String	getName() Get the Name of this operation.
oracle.webservices.model.Operation	getOperation() Get the WebService Operation associated with this Data Control Operation.
Node	getOperationNode() Get the XML representation for this operation.
java.util.Set<java.lang.String>	getOperationParams()
DataFormat	getResponseFormat() Get the reponse format for this operation.
boolean	isComplexAccessorAdded() Returns true if this operation has a complex parameter that has been added as an accessor.
void	setComplexParamContainer(AccessorDef container) Sets the root structure that will contain the complex paramters exposed as accessors.
void	setDefaultParameterValues(java.util.Map<java.lang.String,java.lang.String> paramsMap) Set the default parameter values this operation.
void	setDefaultParmeterValue(java.lang.String name, java.lang.String defaultValue) Set the default parameter values this operation.
void	setResponseFormat(DataFormat responseFormat) Set the response format for this operation.
void	setTypeMap(Types types) Sets the maps of the structures of the types defined for this service definition (WSDL).

Methods inherited from class java.lang.Object

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

Field Detail

RESULT

public static final java.lang.String RESULT

See Also:

Constant Field Values

Constructor Detail

WSOperation

public WSOperation(java.lang.String name)

Creates an instance of the WSOperation.

Parameters:

name - The name of the Webservice operation.

WSOperation

public WSOperation(java.lang.String name,
           oracle.webservices.model.Operation operation)

Create an instance of this WebService operation. The webservice operation encapsulates all the information needed to build the DT representation on the DC palette.

Parameters:

name - The name of the operation

operation - The MDDS model Operation that this DC operation encapsulates.

Method Detail

getName

public java.lang.String getName()

Get the Name of this operation.

Returns:

the name of this Webservice operation

getResponseFormat

public DataFormat getResponseFormat()

Get the reponse format for this operation.

Returns:

Reponse format for this operation format.

See Also:

setResponseFormat(DataFormat repsonseFormat)

setResponseFormat

public void setResponseFormat(DataFormat responseFormat)

Set the response format for this operation. The response format is allows the data to be handled by specific data handlers. Although the response to a SOAP service is always XML, the content of the XML body can be a CSV, HTMLcontent also. Setting the reponse format for this operation allows the design time to persist this information, so that the appropriate format handlers can be invoked.

Parameters:

responseFormat - Response format for this operation.

getOperationNode

public Node getOperationNode()

Get the XML representation for this operation. Generate a DOM subtree and return the root Node of that subtree. This XML representation is a part of the data control metadata. This DOM tree defines the instance construct of the SOAP operation and its parameters at runtime.

Returns:

Node for the XML DOM subtree for this operation structure.

getOperation

public oracle.webservices.model.Operation getOperation()

Get the WebService Operation associated with this Data Control Operation.

Returns:

Operation associated with this Data Control operation.

setDefaultParameterValues

public void setDefaultParameterValues(java.util.Map<java.lang.String,java.lang.String> paramsMap)

Set the default parameter values this operation.

Parameters:

paramsMap - Map containing parameter name and default value, both of type String

setDefaultParmeterValue

public void setDefaultParmeterValue(java.lang.String name,
                           java.lang.String defaultValue)

Set the default parameter values this operation.

Parameters:

name - Parameter name

defaultValue - Default value for the parameter

getDefaultParameterValues

public java.util.Map getDefaultParameterValues()

Returns:

Unmodifiable map with parameter names and their default values. Empty Map if there were no default values set for the parameters

getDefaultParameterValue

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

Returns the default value of the parameter, null, if default value is not set.

Parameters:

name - The parameter name whose default value is to be returned.

Returns:

default Value for the parameter, null if the default value is not set.

getOperationParams

public java.util.Set<java.lang.String> getOperationParams()

Returns:

unmodifiable Set of Parameters associated with this operation. Empty Set if there are no parameters for this operation

getMethodDefintion

public MethodDef getMethodDefintion(StructureDef dcParent)

Create the JSR227 MethodDefinition for this operation. The Appropriate JSR227 structures are built for the input parameters and the return types.

The return type can be a set of multiple RSI's, typically in a case where the SOAP payload can return complex header strucutres along with a complex structures in the body. Each of these strcutures are independent RSI's. In such a case a ROOT AccessorDefinition is created, whose StructureDefinition contains these top level accessors.

The Method parameters can also be complex StructureDefinitions or collections. In such a case, the Complex Structure is flattened out as <parent>_<child>. The parameter values passed are then collated to build complex payload.

Parameters:

dcParent - The Data control Root Structure which contains all the MethodDefinitions.

Returns:

The JSR227 OperationDefinition for this WebService operation

setComplexParamContainer

public void setComplexParamContainer(AccessorDef container)

Sets the root structure that will contain the complex paramters exposed as accessors. User can drop the paramter accessors to create an input form to construct the complex paramter that can be passed to the operation.

Parameters:

struct - the definition that contains the accessors.

isComplexAccessorAdded

public boolean isComplexAccessorAdded()

Returns true if this operation has a complex parameter that has been added as an accessor.

setTypeMap

public void setTypeMap(Types types)

Sets the maps of the structures of the types defined for this service definition (WSDL).

Parameters:

types - object that stores structure definitions with the key as the type names.

getCollectionSet

public java.util.Set getCollectionSet()