org.apache.woden.wsdl20

Interface Interface

All Superinterfaces:

PropertyExtensible, WSDLComponent

All Known Implementing Classes:

InterfaceImpl

public interface Interface
extends WSDLComponent

Represents the Interface component from the WSDL 2.0 Component model. Defines behaviour for accessing the WSDL components nested within the Interface component, including those inherited via Interface extension.

Author:

John Kaputin (jkaputin@apache.org)

Method Summary

Methods

Modifier and Type	Method and Description
InterfaceFault[]	getAllInterfaceFaults() Returns the set of all InterfaceFault components available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly.
InterfaceOperation[]	getAllInterfaceOperations() Returns the set of all InterfaceOperation components available to this Interface, which includes those declared by this Interface and those defined by the Interfaces it extends, directly or indirectly.
Interface	getExtendedInterface(QName interfaceName) Return the named Interface from the {extended interfaces} property of this Interface.
Interface[]	getExtendedInterfaces() Represents the {extended interfaces} property of the Interface component.
InterfaceFault	getFromAllInterfaceFaults(QName faultName) Returns the InterfaceFault with the specified name from the set of all InterfaceFaults available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly.
InterfaceOperation	getFromAllInterfaceOperations(QName operName) Returns the InterfaceOperation with the specified name from the set of all InterfaceOperations available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly.
InterfaceFault	getInterfaceFault(QName faultName) Returns the InterfaceFault with the specified name from the {interface faults} property of this Interface.
InterfaceFault[]	getInterfaceFaults() Represents the {interface faults} property of the Interface component.
InterfaceOperation	getInterfaceOperation(QName operName) Returns the InterfaceOperation with the specified name from the {interface operations} property of this Interface.
InterfaceOperation[]	getInterfaceOperations() Represents the {interface operations} property of the Interface component.
QName	getName() Returns the qualified name representing the {name} property of this Interface.
InterfaceElement	toElement() Returns a WSDLElement that represents the element information item from the WSDL 2.0 infoset that maps to this WSDLComponent.

Methods inherited from interface org.apache.woden.wsdl20.WSDLComponent

equals, getComponentExtensionContext, getFragmentIdentifier, isEquivalentTo, setComponentExtensionContext, toString

Methods inherited from interface org.apache.woden.wsdl20.extensions.PropertyExtensible

getExtensionProperties, getExtensionProperties, getExtensionProperty

Method Detail

getName

QName getName()

Returns the qualified name representing the {name} property of this Interface.

Returns:

QName representing the name of this Interface

getExtendedInterfaces

Interface[] getExtendedInterfaces()

Represents the {extended interfaces} property of the Interface component. This is the set of declared Interface components that this Interface directly extends, but does not include any Interfaces that those Interfaces extend. The method will return an empty array if there are no extended interfaces.

Returns:

an array of Interface components

getExtendedInterface

Interface getExtendedInterface(QName interfaceName)

Return the named Interface from the {extended interfaces} property of this Interface. That is, from the set of declared Interfaces that this Interface directly extends. If null is specified for the name, this method will return null.

Parameters:

interfaceName - the qualified name of the required Interface

Returns:

the named Interface

getInterfaceFaults

InterfaceFault[] getInterfaceFaults()

Represents the {interface faults} property of the Interface component. This is the set of interface faults declared directly by this interface, but not those defined by any interfaces that this interface extends. The method will return an empty array if there are no interface faults.

Returns:

array of InterfaceFault components

getInterfaceFault

InterfaceFault getInterfaceFault(QName faultName)

Returns the InterfaceFault with the specified name from the {interface faults} property of this Interface. That is, from the set of InterfaceFaults declared directly by this Interface and excluding any inherited directly or indirectly from extended Interfaces. If the name parameter is null, this method will return null.

Parameters:

faultName - the qualified name of the InterfaceFault

Returns:

the InterfaceFault object

getAllInterfaceFaults

InterfaceFault[] getAllInterfaceFaults()

Returns the set of all InterfaceFault components available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly. The method will return an empty array if there are no interface faults.

Returns:

array of InterfaceFault components

getFromAllInterfaceFaults

InterfaceFault getFromAllInterfaceFaults(QName faultName)

Returns the InterfaceFault with the specified name from the set of all InterfaceFaults available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly. If the name parameter is null, this method will return null.

Parameters:

faultName - the qualified name of the InterfaceFault

Returns:

the InterfaceFault object

getInterfaceOperations

InterfaceOperation[] getInterfaceOperations()

Represents the {interface operations} property of the Interface component. This is the set of interface operations declared directly by this interface, but not those defined by any interfaces that this interface extends. The method will return an empty array if there are no interface operations.

Returns:

array of InterfaceOperation components

getInterfaceOperation

InterfaceOperation getInterfaceOperation(QName operName)

Returns the InterfaceOperation with the specified name from the {interface operations} property of this Interface. That is, from the set of InterfaceOperations declared directly by this Interface and excluding any inherited directly or indirectly from extended Interfaces. If the name parameter is null, this method will return null.

Parameters:

operName - the qualified name of the required InterfaceOperation

Returns:

the InterfaceOperation object

getAllInterfaceOperations

InterfaceOperation[] getAllInterfaceOperations()

Returns the set of all InterfaceOperation components available to this Interface, which includes those declared by this Interface and those defined by the Interfaces it extends, directly or indirectly. The method will return an empty array if there are no interface operations.

Returns:

array of InterfaceOperation components

getFromAllInterfaceOperations

InterfaceOperation getFromAllInterfaceOperations(QName operName)

Returns the InterfaceOperation with the specified name from the set of all InterfaceOperations available to this Interface, which includes those declared by this Interface and those defined by any Interfaces it extends, directly or indirectly. If the name parameter is null, this method will return null.

Parameters:

operName - the qualified name of the InterfaceOperation

Returns:

the InterfaceOperation object

toElement

InterfaceElement toElement()

Returns a WSDLElement that represents the element information item from the WSDL 2.0 infoset that maps to this WSDLComponent.

Returns:

the InterfaceElement that maps to this Interface