RPCParam (Apache Axis)

java.lang.Object
- org.apache.axis.message.NodeImpl
- - org.apache.axis.message.MessageElement
  - - org.apache.axis.message.RPCParam

All Implemented Interfaces:

Serializable, Cloneable, SOAPElement, Element, Node, NodeList
```
public class RPCParam
extends MessageElement
implements Serializable
```
An RPC parameter

Author:

Glen Daniels (gdaniels@apache.org)

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.axis.message.MessageElement
  MessageElement.QNameAttr

Field Summary

Fields
Modifier and Type Field and Description

protected static org.apache.commons.logging.Log log
- Fields inherited from class org.apache.axis.message.MessageElement
  _isRoot, context, encodingStyle, endEventIndex, fixupDeserializer, href, id, message, namespaces, qNameAttrs, recorder, startContentsIndex, startEventIndex, typeQName
- Fields inherited from class org.apache.axis.message.NodeImpl
  _isDirty, attributes, children, document, name, namespaceURI, parent, prefix, textRep
- Fields inherited from interface org.w3c.dom.Node
  ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields
Modifier and Type	Field and Description
`protected static org.apache.commons.logging.Log`	`log`

Constructor Summary

Constructors
Constructor and Description
`RPCParam(QName qname, Object value)`
`RPCParam(String name, Object value)` Constructor for building up messages.
`RPCParam(String namespace, String name, Object value)`

Method Summary

Methods
Modifier and Type	Method and Description
`SOAPElement`	`addTextNode(String s)` add a text node to the document.
`Object`	`getObjectValue()` Returns value of the node as an object of registered type.
`ParameterDesc`	`getParamDesc()`
`String`	`getValue()` Get the value of the doc as a string.
`static Method`	`getValueSetMethod()`
`Boolean`	`getXSITypeGeneration()`
`protected void`	`outputImpl(SerializationContext context)` override point -output to a serialization context.
`void`	`serialize(SerializationContext context)`
`void`	`set(Object newValue)` This set method is registered during deserialization to set the deserialized value.
`void`	`setObjectValue(Object value)` Sets value of this node to an Object.
`void`	`setParamDesc(ParameterDesc paramDesc)`
`void`	`setRPCCall(RPCElement call)`
`void`	`setValue(String value)` If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node.
`void`	`setXSITypeGeneration(Boolean value)`

Methods inherited from class org.apache.axis.message.MessageElement
addAttribute, addAttribute, addAttribute, addAttribute, addChild, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addMapping, addNamespaceDeclaration, childDeepCloned, cloneNode, cloning, detachAllChildren, equals, findElement, getAllAttributes, getAsDocument, getAsDOM, getAsString, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributesEx, getAttributeValue, getAttributeValue, getChildElement, getChildElements, getChildElements, getChildElements, getChildren, getCompleteAttributes, getDeserializationContext, getElementName, getElementsByTagName, getElementsByTagNameNS, getElementsNS, getEncodingStyle, getEnvelope, getFixupDeserializer, getHref, getID, getLength, getName, getNamespacePrefixes, getNamespaceURI, getObjectValue, getOwnerDocument, getPrefix, getQName, getRealElement, getRecorder, getTagName, getType, getValueAsType, getValueAsType, getValueDOM, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, isRoot, item, output, publishContents, publishToHandler, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeContents, removeNamespaceDeclaration, setAllAttributes, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setContentsIndex, setEncodingStyle, setEndIndex, setEnvelope, setFixupDeserializer, setName, setNamespaceURI, setNSMappings, setQName, setRecorder, setType, toString

Methods inherited from class org.apache.axis.message.NodeImpl
appendChild, convertAttrSAXtoDOM, detachNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getParent, getParentElement, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, initializeChildren, insertBefore, isDirty, isSupported, makeAttributesEditable, normalize, recycleNode, removeChild, replaceChild, reset, setDirty, setDirty, setNodeValue, setOwnerDocument, setParent, setParentElement, setPrefix

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.Node
detachNode, getParentElement, recycleNode, setParentElement

Methods inherited from interface org.w3c.dom.Element
getSchemaTypeInfo, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node
appendChild, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

- Field Detail
  - log
```
protected static org.apache.commons.logging.Log log
```
- Constructor Detail
  - RPCParam
```
public RPCParam(String name,
        Object value)
```
    Constructor for building up messages.
  - RPCParam
```
public RPCParam(QName qname,
        Object value)
```
  - RPCParam
```
public RPCParam(String namespace,
        String name,
        Object value)
```
- Method Detail
  - setRPCCall
```
public void setRPCCall(RPCElement call)
```
  - getObjectValue
```
public Object getObjectValue()
```
    Description copied from class: MessageElement
    
    Returns value of the node as an object of registered type.
    
    Overrides:
    
    getObjectValue in class MessageElement
    
    Returns:
    Object of proper type, or null if no mapping could be found.
  - setObjectValue
```
public void setObjectValue(Object value)
```
    Description copied from class: MessageElement
    
    Sets value of this node to an Object. A serializer needs to be registered for this object class for proper operation.
    Note that this method will log an error and no-op if there are any children in the MessageElement or if the MessageElement was constructed from XML.
    
    Overrides:
    
    setObjectValue in class MessageElement
    
    Parameters:
    value - node's value or null.
  - set
```
public void set(Object newValue)
```
    This set method is registered during deserialization to set the deserialized value. If the method is called multiple times, the value is automatically changed into a container to hold all of the values.
    
    Parameters:
    newValue - is the deserialized object
  - getValueSetMethod
```
public static Method getValueSetMethod()
```
  - getParamDesc
```
public ParameterDesc getParamDesc()
```
  - setParamDesc
```
public void setParamDesc(ParameterDesc paramDesc)
```
  - setXSITypeGeneration
```
public void setXSITypeGeneration(Boolean value)
```
  - getXSITypeGeneration
```
public Boolean getXSITypeGeneration()
```
  - serialize
```
public void serialize(SerializationContext context)
               throws IOException
```
    Throws:
    
    IOException
  - outputImpl
```
protected void outputImpl(SerializationContext context)
                   throws Exception
```
    Description copied from class: MessageElement
    
    override point -output to a serialization context.
    
    Overrides:
    
    outputImpl in class MessageElement
    
    Parameters:
    context - destination.
    
    Throws:
    
    Exception - if something went wrong.
  - getValue
```
public String getValue()
```
    Description copied from class: MessageElement
    
    Get the value of the doc as a string. This uses MessageElement.getAsDOM() so is a heavyweight operation.
    
    Overrides:
    
    getValue in class MessageElement
    
    Returns:
    the value of any child node, or null if there is no node/something went wrong during serialization. If the first child is text, the return value is the text itself.
    See Also:
    ;
  - addTextNode
```
public SOAPElement addTextNode(String s)
                        throws SOAPException
```
    Description copied from class: MessageElement
    
    add a text node to the document.
    
    Specified by:
    
    addTextNode in interface SOAPElement
    
    Overrides:
    
    addTextNode in class MessageElement
    
    Parameters:
    s - a String object with the textual content to be added
    
    Returns:
    ourselves
    
    Throws:
    
    SOAPException - if there is an error in creating the new Text object
    See Also:
    SOAPElement.addTextNode(java.lang.String)
  - setValue
```
public void setValue(String value)
```
    Description copied from class: NodeImpl
    
    If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node. The value of the immediate child of this node can be set only if, there is one child node and that node is a Text node, or if there are no children in which case a child Text node will be created.
    
    Overrides:
    
    setValue in class MessageElement
    
    Parameters:
    value - the text to set
    See Also:
    Node.setValue(java.lang.String)

Class RPCParam

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.axis.message.MessageElement

Field Summary

Fields inherited from class org.apache.axis.message.MessageElement

Fields inherited from class org.apache.axis.message.NodeImpl

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class org.apache.axis.message.MessageElement

Methods inherited from class org.apache.axis.message.NodeImpl

Methods inherited from class java.lang.Object

Methods inherited from interface javax.xml.soap.Node

Methods inherited from interface org.w3c.dom.Element

Methods inherited from interface org.w3c.dom.Node

Field Detail

log

Constructor Detail

RPCParam

RPCParam

RPCParam

Method Detail

setRPCCall

getObjectValue

setObjectValue

set

getValueSetMethod

getParamDesc

setParamDesc

setXSITypeGeneration

getXSITypeGeneration

serialize

outputImpl

getValue

addTextNode

setValue