javax.wsdl
Interface PortType

All Superinterfaces:
AttributeExtensible, java.io.Serializable
All Known Implementing Classes:
PortTypeImpl

public interface PortType
extends java.io.Serializable, AttributeExtensible

This interface represents a port type. It contains information about operations associated with this port type.

Author:
Paul Fremantle, Nirmal Mukhi, Matthew J. Duftler

Field Summary
 
Fields inherited from interface javax.wsdl.extensions.AttributeExtensible
LIST_OF_QNAMES_TYPE, LIST_OF_STRINGS_TYPE, NO_DECLARED_TYPE, QNAME_TYPE, STRING_TYPE
 
Method Summary
 void addOperation(Operation operation)
          Add an operation to this port type.
 org.w3c.dom.Element getDocumentationElement()
          Get the documentation element.
 Operation getOperation(java.lang.String name, java.lang.String inputName, java.lang.String outputName)
          Get the specified operation.
 java.util.List getOperations()
          Get all the operations defined here.
 QName getQName()
          Get the name of this port type.
 boolean isUndefined()
           
 void setDocumentationElement(org.w3c.dom.Element docEl)
          Set the documentation element for this document.
 void setQName(QName name)
          Set the name of this port type.
 void setUndefined(boolean isUndefined)
           
 
Methods inherited from interface javax.wsdl.extensions.AttributeExtensible
getExtensionAttribute, getExtensionAttributes, getNativeAttributeNames, setExtensionAttribute
 

Method Detail

setQName

public void setQName(QName name)
Set the name of this port type.

Parameters:
name - the desired name

getQName

public QName getQName()
Get the name of this port type.

Returns:
the port type name

addOperation

public void addOperation(Operation operation)
Add an operation to this port type.

Parameters:
operation - the operation to be added

getOperation

public Operation getOperation(java.lang.String name,
                              java.lang.String inputName,
                              java.lang.String outputName)
Get the specified operation. Note that operation names can be overloaded within a PortType. In case of overloading, the names of the input and output messages can be used to further refine the search.

Parameters:
name - the name of the desired operation.
inputName - the name of the input message; if this is null it will be ignored.
outputName - the name of the output message; if this is null it will be ignored.
Returns:
the corresponding operation, or null if there wasn't any matching operation

getOperations

public java.util.List getOperations()
Get all the operations defined here.


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.

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.

Returns:
the documentation element

setUndefined

public void setUndefined(boolean isUndefined)

isUndefined

public boolean isUndefined()


Copyright ? 2003 IBM. All Rights Reserved.