|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.xfire.annotations.WebParamAnnotation
public class WebParamAnnotation
Represents a common representation of a web parameter annotation. Customizes the mapping of an individual parameter to a Web Service message part and XML element.
Field Summary | |
---|---|
static int |
MODE_IN
Constant used to specify that a parameter flows inwards. |
static int |
MODE_INOUT
Constant used to specify that a parameter flows both in and outwards. |
static int |
MODE_OUT
Constant used to specify that a parameter flows outwards. |
Constructor Summary | |
---|---|
WebParamAnnotation()
|
Method Summary | |
---|---|
int |
getMode()
Returns the direction in which the parameter is flowing. |
String |
getName()
Returns the name of the parameter as it appears in the WSDL. |
String |
getPartName()
|
String |
getTargetNamespace()
Returns the XML namespace for the parameter. |
boolean |
isHeader()
If true , the parameter is pulled from a message header rather then the message body. |
void |
setHeader(boolean header)
Determines whether this parameter is a header. |
void |
setMode(int mode)
Sets the direction in which the parameter is flowing. |
void |
setName(String name)
Sets the name of the parameter as it appears in the WSDL. |
void |
setPartName(String partName)
|
void |
setTargetNamespace(String targetNamespace)
Sets the XML namespace for the parameter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int MODE_IN
public static final int MODE_INOUT
public static final int MODE_OUT
Constructor Detail |
---|
public WebParamAnnotation()
Method Detail |
---|
public String getPartName()
public void setPartName(String partName)
public String getName()
public void setName(String name)
name
- the new name of the parameter as it appears in the WSDL.public String getTargetNamespace()
public void setTargetNamespace(String targetNamespace)
targetNamespace
- the XML namespace for the parameter.public int getMode()
MODE_IN
, MODE_OUT
, or MODE_INOUT
.
public void setMode(int mode)
MODE_IN
, MODE_OUT
, or MODE_INOUT
.
mode
- the new parameter mode.
IllegalArgumentException
- if mode
is not a valid mode.public boolean isHeader()
true
, the parameter is pulled from a message header rather then the message body.
true
if a header; false
otherwise.public void setHeader(boolean header)
header
- true
if a header; false
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |