com.ibm.wsdl
Class OperationImpl

java.lang.Object
  extended bycom.ibm.wsdl.OperationImpl
All Implemented Interfaces:
AttributeExtensible, Operation, java.io.Serializable

public class OperationImpl
extends java.lang.Object
implements Operation

This class represents a WSDL operation. It includes information on input, output and fault messages associated with usage of the operation.

Author:
Paul Fremantle (pzf@us.ibm.com), Nirmal Mukhi (nmukhi@us.ibm.com), Matthew J. Duftler (duftler@us.ibm.com)
See Also:
Serialized Form

Field Summary
protected  org.w3c.dom.Element docEl
           
protected  java.util.Map extensionAttributes
           
protected  java.util.Map faults
           
protected  Input input
           
protected  boolean isUndefined
           
protected  java.lang.String name
           
protected  java.util.List nativeAttributeNames
           
protected  Output output
           
protected  java.util.List parameterOrder
           
static long serialVersionUID
           
protected  OperationType style
           
 
Fields inherited from interface javax.wsdl.extensions.AttributeExtensible
LIST_OF_QNAMES_TYPE, LIST_OF_STRINGS_TYPE, NO_DECLARED_TYPE, QNAME_TYPE, STRING_TYPE
 
Constructor Summary
OperationImpl()
           
 
Method Summary
 void addFault(Fault fault)
          Add a fault message that must be associated with this operation.
 org.w3c.dom.Element getDocumentationElement()
          Get the documentation element.
 java.lang.Object getExtensionAttribute(QName name)
          Retrieve an extension attribute from this element.
 java.util.Map getExtensionAttributes()
          Get the map containing all the extension attributes defined on this element.
 Fault getFault(java.lang.String name)
          Get the specified fault message.
 java.util.Map getFaults()
          Get all the fault messages associated with this operation.
 Input getInput()
          Get the input message specification for this operation.
 java.lang.String getName()
          Get the name of this operation.
 java.util.List getNativeAttributeNames()
          Get the list of local attribute names defined for this element in the WSDL specification.
 Output getOutput()
          Get the output message specification for this operation.
 java.util.List getParameterOrdering()
          Get the parameter ordering for this operation.
 OperationType getStyle()
          Get the operation type.
 boolean isUndefined()
           
 void setDocumentationElement(org.w3c.dom.Element docEl)
          Set the documentation element for this document.
 void setExtensionAttribute(QName name, java.lang.Object value)
          Set an extension attribute on this element.
 void setInput(Input input)
          Set the input message specification for this operation.
 void setName(java.lang.String name)
          Set the name of this operation.
 void setOutput(Output output)
          Set the output message specification for this operation.
 void setParameterOrdering(java.util.List parameterOrder)
          Set the parameter ordering for a request-response, or solicit-response operation.
 void setStyle(OperationType style)
          Set the style for this operation (request-response, one way, solicit-response or notification).
 void setUndefined(boolean isUndefined)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

input

protected Input input

output

protected Output output

faults

protected java.util.Map faults

style

protected OperationType style

parameterOrder

protected java.util.List parameterOrder

docEl

protected org.w3c.dom.Element docEl

extensionAttributes

protected java.util.Map extensionAttributes

nativeAttributeNames

protected java.util.List nativeAttributeNames

isUndefined

protected boolean isUndefined

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

OperationImpl

public OperationImpl()
Method Detail

setName

public void setName(java.lang.String name)
Set the name of this operation.

Specified by:
setName in interface Operation
Parameters:
name - the desired name

getName

public java.lang.String getName()
Get the name of this operation.

Specified by:
getName in interface Operation
Returns:
the operation name

setInput

public void setInput(Input input)
Set the input message specification for this operation.

Specified by:
setInput in interface Operation
Parameters:
input - the new input message

getInput

public Input getInput()
Get the input message specification for this operation.

Specified by:
getInput in interface Operation
Returns:
the input message

setOutput

public void setOutput(Output output)
Set the output message specification for this operation.

Specified by:
setOutput in interface Operation
Parameters:
output - the new output message

getOutput

public Output getOutput()
Get the output message specification for this operation.

Specified by:
getOutput in interface Operation
Returns:
the output message specification for the operation

addFault

public void addFault(Fault fault)
Add a fault message that must be associated with this operation.

Specified by:
addFault in interface Operation
Parameters:
fault - the new fault message

getFault

public Fault getFault(java.lang.String name)
Get the specified fault message.

Specified by:
getFault in interface Operation
Parameters:
name - the name of the desired fault message.
Returns:
the corresponding fault message, or null if there wasn't any matching message

getFaults

public java.util.Map getFaults()
Get all the fault messages associated with this operation.

Specified by:
getFaults in interface Operation
Returns:
names of fault messages

setStyle

public void setStyle(OperationType style)
Set the style for this operation (request-response, one way, solicit-response or notification).

Specified by:
setStyle in interface Operation
Parameters:
style - the new operation style

getStyle

public OperationType getStyle()
Get the operation type.

Specified by:
getStyle in interface Operation
Returns:
the operation type

setParameterOrdering

public void setParameterOrdering(java.util.List parameterOrder)
Set the parameter ordering for a request-response, or solicit-response operation.

Specified by:
setParameterOrdering in interface Operation

getParameterOrdering

public java.util.List getParameterOrdering()
Get the parameter ordering for this operation.

Specified by:
getParameterOrdering in interface Operation
Returns:
the parameter ordering, a list consisting of message part names

setDocumentationElement

public void setDocumentationElement(org.w3c.dom.Element docEl)
Set the documentation element for this document. This dependency on org.w3c.dom.Element should eventually be removed when a more appropriate way of representing this information is employed.

Specified by:
setDocumentationElement in interface Operation
Parameters:
docEl - the documentation element

getDocumentationElement

public org.w3c.dom.Element getDocumentationElement()
Get the documentation element. This dependency on org.w3c.dom.Element should eventually be removed when a more appropriate way of representing this information is employed.

Specified by:
getDocumentationElement in interface Operation
Returns:
the documentation element

setExtensionAttribute

public void setExtensionAttribute(QName name,
                                  java.lang.Object value)
Set an extension attribute on this element. Pass in a null value to remove an extension attribute.

Specified by:
setExtensionAttribute in interface AttributeExtensible
Parameters:
name - the extension attribute name
value - the extension attribute value. Can be a String, a QName, a List of Strings, or a List of QNames.
See Also:
getExtensionAttribute(javax.xml.namespace.QName), getExtensionAttributes(), ExtensionRegistry#registerExtensionAttributeType, ExtensionRegistry#queryExtensionAttributeType

getExtensionAttribute

public java.lang.Object getExtensionAttribute(QName name)
Retrieve an extension attribute from this element. If the extension attribute is not defined, null is returned.

Specified by:
getExtensionAttribute in interface AttributeExtensible
Parameters:
name - the extension attribute name
Returns:
the value of the extension attribute, or null if it is not defined. Can be a String, a QName, a List of Strings, or a List of QNames.
See Also:
setExtensionAttribute(javax.xml.namespace.QName, java.lang.Object), getExtensionAttributes(), ExtensionRegistry#registerExtensionAttributeType, ExtensionRegistry#queryExtensionAttributeType

getExtensionAttributes

public java.util.Map getExtensionAttributes()
Get the map containing all the extension attributes defined on this element. The keys are the qnames of the attributes.

Specified by:
getExtensionAttributes in interface AttributeExtensible
Returns:
a map containing all the extension attributes defined on this element
See Also:
setExtensionAttribute(javax.xml.namespace.QName, java.lang.Object), getExtensionAttribute(javax.xml.namespace.QName)

getNativeAttributeNames

public java.util.List getNativeAttributeNames()
Get the list of local attribute names defined for this element in the WSDL specification.

Specified by:
getNativeAttributeNames in interface AttributeExtensible
Returns:
a List of Strings, one for each local attribute name

setUndefined

public void setUndefined(boolean isUndefined)
Specified by:
setUndefined in interface Operation

isUndefined

public boolean isUndefined()
Specified by:
isUndefined in interface Operation

toString

public java.lang.String toString()


Copyright ? 2003 IBM. All Rights Reserved.