org.codehaus.xfire.annotations
Class WebResultAnnotation

java.lang.Object
  extended by org.codehaus.xfire.annotations.WebResultAnnotation
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
WebResult

public class WebResultAnnotation
extends Object
implements Serializable

Represents an common representation of a web result annotation. Customizes the mapping of the return value to a WSDL part and XML element.

Author:
Arjen Poutsma
See Also:
Serialized Form

Constructor Summary
WebResultAnnotation()
           
 
Method Summary
 String getName()
          Returns the name of the return value as it appears in the WSDL and messages on the wire.
 String getPartName()
           
 String getTargetNamespace()
          Returns the XML namespace for the return value.
 boolean isHeader()
           
 void setHeader(boolean header)
           
 void setName(String name)
          Sets the name of return value as it appears in the WSDL and messages on the wire.
 void setPartName(String partName)
           
 void setTargetNamespace(String targetNamespace)
          Sets the XML namespace for the return value.
 String toString()
          Returns a String representation of this WebResultAnnotation attribute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WebResultAnnotation

public WebResultAnnotation()
Method Detail

getPartName

public String getPartName()

setPartName

public void setPartName(String partName)

isHeader

public boolean isHeader()

setHeader

public void setHeader(boolean header)

getName

public String getName()
Returns the name of the return value as it appears in the WSDL and messages on the wire. For RPC bindings, this is the name of the wsdl:part representing the return value. For document bindings, this is the local name of the XML element representing the return value.

Returns:
the name of the return value.

setName

public void setName(String name)
Sets the name of return value as it appears in the WSDL and messages on the wire. For RPC bindings, this is the name of the wsdl:part representing the return value. For document bindings, this is the local name of the XML element representing the return value.

Parameters:
name - the new name of the return value.

getTargetNamespace

public String getTargetNamespace()
Returns the XML namespace for the return value. Only used with document bindings, where the return value maps to an XML element. Defaults to the targetNamespace of the Web Service.

Returns:
the XML namespace for the return value.

setTargetNamespace

public void setTargetNamespace(String targetNamespace)
Sets the XML namespace for the return value. Only used with document bindings, where the return value maps to an XML element. Defaults to the targetNamespace of the Web Service.

Parameters:
targetNamespace - the new XML namespace for the return value.

toString

public String toString()
Returns a String representation of this WebResultAnnotation attribute.

Overrides:
toString in class Object
Returns:
a string representation.


Copyright © 2004-2013. All Rights Reserved.