com.sun.jbi.wsdl2

Interface InterfaceOperation

All Superinterfaces:

ExtensibleDocumentedComponent

public interface InterfaceOperation
extends ExtensibleDocumentedComponent

API for WSDL 2.0 interface operation component.

Author:

ApiGen AX.00

Method Summary

Methods

Modifier and Type	Method and Description
MessageFaultReference	addNewInFault(InterfaceFault fault) Create a new messsage in-fault reference for this operation, and append it to the operation's in-fault list.
MessageReference	addNewInput() Create a new input message reference for this operation, and append it to this operation's input list.
MessageFaultReference	addNewOutFault(InterfaceFault fault) Create a new messsage out-fault reference for this operation, and append it to the operation's out-fault list.
MessageReference	addNewOutput() Create a new output message reference for this operation, and append it to this operation's output list.
void	appendInFault(MessageFaultReference theInFault) Append an item to in fault message references.
void	appendInput(MessageReference theInput) Append an item to input message references.
void	appendOutFault(MessageFaultReference theOutFault) Append an item to out fault message references.
void	appendOutput(MessageReference theOutput) Append an item to output message references.
MessageFaultReference	getInFault(int index) Get in fault message references by indexed position.
int	getInFaultsLength() Get the number of MessageFaultReference items in inFaults.
MessageReference	getInput(int index) Get input message references by indexed position.
int	getInputsLength() Get the number of MessageReference items in inputs.
String	getName() Get name of this interface operation component.
MessageFaultReference	getOutFault(int index) Get out fault message references by indexed position.
int	getOutFaultsLength() Get the number of MessageFaultReference items in outFaults.
MessageReference	getOutput(int index) Get output message references by indexed position.
int	getOutputsLength() Get the number of MessageReference items in outputs.
String	getPattern() Get message exchange pattern URI for this operation.
QName	getQualifiedName() Get qualified name of this interface operation.
boolean	getSafe() Get true if the operation is safe, as defined by the W3C Web Services Architecture document.
String	getStyle() Get a URI identifying the message construction rules for a message reference.
MessageFaultReference	removeInFault(int index) Remove in fault message references by index position.
MessageReference	removeInput(int index) Remove input message references by index position.
MessageFaultReference	removeOutFault(int index) Remove out fault message references by index position.
MessageReference	removeOutput(int index) Remove output message references by index position.
void	setInFault(int index, MessageFaultReference theInFault) Set in fault message references by indexed position.
void	setInput(int index, MessageReference theInput) Set input message references by indexed position.
void	setName(String theName) Set name of this interface operation component.
void	setOutFault(int index, MessageFaultReference theOutFault) Set out fault message references by indexed position.
void	setOutput(int index, MessageReference theOutput) Set output message references by indexed position.
void	setPattern(String thePattern) Set message exchange pattern URI for this operation.
void	setSafe(boolean isSafe) Set true if the operation is safe, as defined by the W3C Web Services Architecture document.
void	setStyle(String theStyle) Set a URI identifying the message construction rules for a message reference.
DocumentFragment	toXmlDocumentFragment() Return this interface operation as a DOM document fragment.
String	toXmlString() Return this WSDL interface operation as an XML string.

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

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

Method Detail

getName

String getName()

Get name of this interface operation component.

Returns:

Name of this interface operation component

setName

void setName(String theName)

Set name of this interface operation component.

Parameters:

theName - Name of this interface operation component

getPattern

String getPattern()

Get message exchange pattern URI for this operation.

Returns:

Message exchange pattern URI for this operation

setPattern

void setPattern(String thePattern)

Set message exchange pattern URI for this operation.

Parameters:

thePattern - Message exchange pattern URI for this operation

getStyle

String getStyle()

Get a URI identifying the message construction rules for a message reference.

Returns:

A URI identifying the message construction rules for a message reference

setStyle

void setStyle(String theStyle)

Set a URI identifying the message construction rules for a message reference.

Parameters:

theStyle - A URI identifying the message construction rules for a message reference

getSafe

boolean getSafe()

Get true if the operation is safe, as defined by the W3C Web Services Architecture document.

Returns:

True if the operation is safe, as defined by the W3C Web Services Architecture document

setSafe

void setSafe(boolean isSafe)

Set true if the operation is safe, as defined by the W3C Web Services Architecture document.

Parameters:

isSafe - True if the operation is safe, as defined by the W3C Web Services Architecture document

getInputsLength

int getInputsLength()

Get the number of MessageReference items in inputs.

Returns:

The number of MessageReference items in inputs

getInput

MessageReference getInput(int index)

Get input message references by indexed position.

Parameters:

index - Indexed position value 0..length-1

Returns:

Input message references at given index position.

setInput

void setInput(int index,
            MessageReference theInput)

Set input message references by indexed position.

Parameters:

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

theInput - Item to add at position index.

appendInput

void appendInput(MessageReference theInput)

Append an item to input message references.

Parameters:

theInput - Item to append to inputs

removeInput

MessageReference removeInput(int index)

Remove input message references by index position.

Parameters:

index - The index position of the input to remove

Returns:

The MessageReference removed, if any.

getOutputsLength

int getOutputsLength()

Get the number of MessageReference items in outputs.

Returns:

The number of MessageReference items in outputs

getOutput

MessageReference getOutput(int index)

Get output message references by indexed position.

Parameters:

index - Indexed position value 0..length-1

Returns:

Output message references at given index position.

setOutput

void setOutput(int index,
             MessageReference theOutput)

Set output message references by indexed position.

Parameters:

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

theOutput - Item to add at position index.

appendOutput

void appendOutput(MessageReference theOutput)

Append an item to output message references.

Parameters:

theOutput - Item to append to outputs

removeOutput

MessageReference removeOutput(int index)

Remove output message references by index position.

Parameters:

index - The index position of the output to remove

Returns:

The MessageReference removed, if any.

getInFaultsLength

int getInFaultsLength()

Get the number of MessageFaultReference items in inFaults.

Returns:

The number of MessageFaultReference items in inFaults

getInFault

MessageFaultReference getInFault(int index)

Get in fault message references by indexed position.

Parameters:

index - Indexed position value 0..length-1

Returns:

In fault message references at given index position.

setInFault

void setInFault(int index,
              MessageFaultReference theInFault)

Set in fault message references by indexed position.

Parameters:

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

theInFault - Item to add at position index.

appendInFault

void appendInFault(MessageFaultReference theInFault)

Append an item to in fault message references.

Parameters:

theInFault - Item to append to inFaults

removeInFault

MessageFaultReference removeInFault(int index)

Remove in fault message references by index position.

Parameters:

index - The index position of the inFault to remove

Returns:

The MessageFaultReference removed, if any.

getOutFaultsLength

int getOutFaultsLength()

Get the number of MessageFaultReference items in outFaults.

Returns:

The number of MessageFaultReference items in outFaults

getOutFault

MessageFaultReference getOutFault(int index)

Get out fault message references by indexed position.

Parameters:

index - Indexed position value 0..length-1

Returns:

Out fault message references at given index position.

setOutFault

void setOutFault(int index,
               MessageFaultReference theOutFault)

Set out fault message references by indexed position.

Parameters:

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

theOutFault - Item to add at position index.

appendOutFault

void appendOutFault(MessageFaultReference theOutFault)

Append an item to out fault message references.

Parameters:

theOutFault - Item to append to outFaults

removeOutFault

MessageFaultReference removeOutFault(int index)

Remove out fault message references by index position.

Parameters:

index - The index position of the outFault to remove

Returns:

The MessageFaultReference removed, if any.

getQualifiedName

QName getQualifiedName()

Get qualified name of this interface operation.

Returns:

Qualified name of this interface operation

addNewInput

MessageReference addNewInput()

Create a new input message reference for this operation, and append it to this operation's input list.

Returns:

The newly created input message reference.

addNewOutput

MessageReference addNewOutput()

Create a new output message reference for this operation, and append it to this operation's output list.

Returns:

The newly created input message reference.

addNewInFault

MessageFaultReference addNewInFault(InterfaceFault fault)

Create a new messsage in-fault reference for this operation, and append it to the operation's in-fault list.

Parameters:

fault - Fault referenced by the new in-fault

Returns:

The newly created in-fault reference.

addNewOutFault

MessageFaultReference addNewOutFault(InterfaceFault fault)

Create a new messsage out-fault reference for this operation, and append it to the operation's out-fault list.

Parameters:

fault - Fault referenced by the new out-fault

Returns:

The newly created out-fault reference.

toXmlString

String toXmlString()

Return this WSDL interface operation as an XML string.

Returns:

This operation, serialized as an XML string.

toXmlDocumentFragment

DocumentFragment toXmlDocumentFragment()

Return this interface operation as a DOM document fragment. The DOM subtree is a copy; altering it will not affect this service.

Returns:

This operation, as a DOM document fragment.