com.webobjects.webservices.client
Class WOClientOperation

java.lang.Object
  |
  +--com.webobjects.webservices.client.WOClientOperation

public class WOClientOperation

extends Object

A WOClientOperation represents a single SOAP HTTP Web service operation as defined in the WSDL document used to create a WOWebServiceClient.

Method Summary

URL	endpoint() Returns the URL at which the service is being vended.
boolean	isDocumentStyle() Return true if this is a document style operation (ie.
boolean	isRPCStyle() Return true if this is an RPC operation (ie.
String	name() Returns the name of the operation.
NSMutableArray	parameters() Returns an NSMutableArray containing WOClientParameters for the parameters taken by this operation.
NSMutableArray	returnTypes() Returns an NSMutableArray of WOClientParameters representing the types returned by the operation.
void	setSoapAction(String aString) Set the HTTP SoapAction header to be used when invoking the operation.
void	setStyle(String aStyle) Set the operation style to aStyle.
String	soapAction() Returns the soapAction HTTP header to be used when invoking the operation.
String	style() Returns a string denoting the style of SOAP operation represented by the receiver.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

endpoint

public URL endpoint()

Returns the URL at which the service is being vended.

Returns:

the URL at which the operation is vended

isDocumentStyle

public boolean isDocumentStyle()

Return true if this is a document style operation (ie. style is "document").

Returns:

true if this is a document style operation

isRPCStyle

public boolean isRPCStyle()

Return true if this is an RPC operation (ie. style is "RPC").

Returns:

true if this is an RPC operation

name

public String name()

Returns the name of the operation.

Returns:

the name of the operation

parameters

public NSMutableArray parameters()

Returns an NSMutableArray containing WOClientParameters for the parameters taken by this operation. For an RPC operation, the WOClientParameters will be in the order in which the parameters are to be passed to invoke; for a document style operation, there should be only one in parameter.

Returns:

an NSMutableArray of WOClientParameters

See Also:

WOWebServiceClient#invoke(String anOperation, Object[] parameters), ParameterMode

returnTypes

public NSMutableArray returnTypes()

Returns an NSMutableArray of WOClientParameters representing the types returned by the operation. For an RPC operation, the WOClientParameters will be in the order in which the out parts are specified in the WSDL. If there are more than one out only parameters, only the first will be returned. For document style operations, there should be only one return type.

Returns:

an NSMutableArray of WOClientParameters

See Also:

ParameterMode

setSoapAction

public void setSoapAction(String aString)

Set the HTTP SoapAction header to be used when invoking the operation.

Parameters:

String - containing the header to be used when invoking the operation

setStyle

public void setStyle(String aStyle)

Set the operation style to aStyle. aStyle must be one of "RPC" or "document" (case insensitive).

Parameters:

aStyle - String indicating the document style

soapAction

public String soapAction()

Returns the soapAction HTTP header to be used when invoking the operation.

Returns:

the soapAction of the operation

style

public String style()

Returns a string denoting the style of SOAP operation represented by the receiver. Will be either "RPC" or "document".

Returns:

a String representing the style of the operation

toString

public String toString()

Overrides:

toString in class Object