com.sun.jbi.wsdl2

Interface Interface

All Superinterfaces:

ExtensibleDocumentedComponent

public interface Interface
extends ExtensibleDocumentedComponent

API for WSDL 2.0 Interface Component.

Author:

ApiGen AX.00

Method Summary

Methods

Modifier and Type	Method and Description
InterfaceFault	addNewFault(String name) Create a new fault, and append it to this interface's faults list.
InterfaceOperation	addNewOperation() Create a new operation, appending it to this interface's operations list.
void	appendFault(InterfaceFault theFault) Append an item to faults that may occur executing operations of this interface.
void	appendInterface(Interface theInterface) Append an item to interfaces this interface extends, if any.
void	appendOperation(InterfaceOperation theOperation) Append an item to operations defined by this interface only.
Interface[]	getExtendedInterfaces() Get the interfaces extended by this interface, including those extended by this interface's super-interfaces.
InterfaceOperation[]	getExtendedOperations() Get the operations defined by this interface, and all its super-interfaces.
InterfaceFault	getFault(int index) Get faults that may occur executing operations of this interface by indexed position.
int	getFaultsLength() Get the number of InterfaceFault items in faults.
Interface	getInterface(int index) Get interfaces this interface extends, if any by indexed position.
int	getInterfacesLength() Get the number of Interface items in interfaces.
String	getName() Get local name of this interface component.
InterfaceOperation	getOperation(int index) Get operations defined by this interface only by indexed position.
int	getOperationsLength() Get the number of InterfaceOperation items in operations.
QName	getQName() Get qualified name of this component.
URI[]	getStyleDefault() Get the default styles used to construct the {element} properties of {message references} of all operations contained in this interface.
String	getTargetNamespace() Get target namespace of this binding.
InterfaceFault	removeFault(int index) Remove faults that may occur executing operations of this interface by index position.
Interface	removeInterface(int index) Remove interfaces this interface extends, if any by index position.
InterfaceOperation	removeOperation(int index) Remove operations defined by this interface only by index position.
void	setFault(int index, InterfaceFault theFault) Set faults that may occur executing operations of this interface by indexed position.
void	setInterface(int index, Interface theInterface) Set interfaces this interface extends, if any by indexed position.
void	setName(String theName) Set local name of this interface component.
void	setOperation(int index, InterfaceOperation theOperation) Set operations defined by this interface only by indexed position.
void	setStyleDefault(URI[] theStyleDefault) Set the default styles used to construct the {element} properties of {message references} of all operations contained in this interface.

Methods inherited from interface com.sun.jbi.wsdl2.ExtensibleDocumentedComponent

getDocument, getDocument, getExtensions, getWsdlAttributeNameMap, setDocument, setDocument, setExtensions

Method Detail

getTargetNamespace

String getTargetNamespace()

Get target namespace of this binding.

Returns:

Target namespace of this binding

getName

String getName()

Get local name of this interface component.

Returns:

Local name of this interface component

setName

void setName(String theName)

Set local name of this interface component.

Parameters:

theName - Local name of this interface component

getQName

QName getQName()

Get qualified name of this component.

Returns:

Qualified name of this component

getInterfacesLength

int getInterfacesLength()

Get the number of Interface items in interfaces.

Returns:

The number of Interface items in interfaces

getInterface

Interface getInterface(int index)

Get interfaces this interface extends, if any by indexed position.

Parameters:

index - Indexed position value 0..length-1

Returns:

Interfaces this interface extends, if any at given index position.

setInterface

void setInterface(int index,
                Interface theInterface)

Set interfaces this interface extends, if any by indexed position.

Parameters:

index - Indexed position value (0..length-1) of the item to set

theInterface - Item to add at position index.

appendInterface

void appendInterface(Interface theInterface)

Append an item to interfaces this interface extends, if any.

Parameters:

theInterface - Item to append to interfaces

removeInterface

Interface removeInterface(int index)

Remove interfaces this interface extends, if any by index position.

Parameters:

index - The index position of the interface to remove

Returns:

The Interface removed, if any.

getFaultsLength

int getFaultsLength()

Get the number of InterfaceFault items in faults.

Returns:

The number of InterfaceFault items in faults

getFault

InterfaceFault getFault(int index)

Get faults that may occur executing operations of this interface by indexed position.

Parameters:

index - Indexed position value 0..length-1

Returns:

Faults that may occur executing operations of this interface at given index position.

setFault

void setFault(int index,
            InterfaceFault theFault)

Set faults that may occur executing operations of this interface by indexed position.

Parameters:

index - Indexed position value (0..length-1) of the item to set

theFault - Item to add at position index.

appendFault

void appendFault(InterfaceFault theFault)

Append an item to faults that may occur executing operations of this interface.

Parameters:

theFault - Item to append to faults

removeFault

InterfaceFault removeFault(int index)

Remove faults that may occur executing operations of this interface by index position.

Parameters:

index - The index position of the fault to remove

Returns:

The InterfaceFault removed, if any.

getStyleDefault

URI[] getStyleDefault()

Get the default styles used to construct the {element} properties of {message references} of all operations contained in this interface.

Returns:

The default styles used to construct the {element} properties of {message references} of all operations contained in this interface

setStyleDefault

void setStyleDefault(URI[] theStyleDefault)

Set the default styles used to construct the {element} properties of {message references} of all operations contained in this interface.

Parameters:

theStyleDefault - The default styles used to construct the {element} properties of {message references} of all operations contained in this interface

getOperationsLength

int getOperationsLength()

Get the number of InterfaceOperation items in operations.

Returns:

The number of InterfaceOperation items in operations

getOperation

InterfaceOperation getOperation(int index)

Get operations defined by this interface only by indexed position.

Parameters:

index - Indexed position value 0..length-1

Returns:

operations defined by this interface only at given index position.

setOperation

void setOperation(int index,
                InterfaceOperation theOperation)

Set operations defined by this interface only by indexed position.

Parameters:

index - Indexed position value (0..length-1) of the item to set

theOperation - Item to add at position index.

appendOperation

void appendOperation(InterfaceOperation theOperation)

Append an item to operations defined by this interface only.

Parameters:

theOperation - Item to append to operations

removeOperation

InterfaceOperation removeOperation(int index)

Remove operations defined by this interface only by index position.

Parameters:

index - The index position of the operation to remove

Returns:

The InterfaceOperation removed, if any.

getExtendedInterfaces

Interface[] getExtendedInterfaces()

Get the interfaces extended by this interface, including those extended by this interface's super-interfaces.

Returns:

Extended interfaces, including those extended by this interface's super-interfaces

getExtendedOperations

InterfaceOperation[] getExtendedOperations()

Get the operations defined by this interface, and all its super-interfaces.

Returns:

Operations defined by this interface, and all super-interfaces

addNewOperation

InterfaceOperation addNewOperation()

Create a new operation, appending it to this interface's operations list.

Returns:

Newly created operation, appended to the operations list.

addNewFault

InterfaceFault addNewFault(String name)

Create a new fault, and append it to this interface's faults list.

Parameters:

name - Name of the new fault

Returns:

Newly created interface, appended to the faults list.