com.ail.core.xmlbinding
Interface FromXMLArg

All Superinterfaces:
CommandArg, java.io.Serializable
All Known Implementing Classes:
FromXMLArgImp, FromXMLCommand

public interface FromXMLArg
extends CommandArg

Interface defining the bean class to encapsulate the arguments and returns used by the FromXML entry point(s).

Version:
$Revision: 1.2 $

Method Summary
 java.lang.Class getClassIn()
          Get the value of the ClassIn argument.
 java.lang.Object getObjectOut()
          Fetch the value of ObjectOut.
 XMLString getXmlIn()
          Fetch the XMLString that will be unmarshalled by the entry point.
 XMLMapping getXmlMappingInOut()
          Get the value of XmlMapping.
 void setClassIn(java.lang.Class classIn)
          Set the value of the ClassIn property.
 void setObjectOut(java.lang.Object objectOut)
          Set the value of the ObjectOut property.
 void setXmlIn(XMLString xmIn)
          Set the value of the XmlIn property.
 void setXmlMappingInOut(XMLMapping xmlMapping)
          Set the XML mapping property.
 
Methods inherited from interface com.ail.core.command.CommandArg
getCallersCore, setCallersCore
 

Method Detail

getObjectOut

java.lang.Object getObjectOut()
Fetch the value of ObjectOut. This is the value retured from the FromXML entry point, and represents the object created when XmlIn was unmarshalled.

Returns:
Unmarshalled object

setObjectOut

void setObjectOut(java.lang.Object objectOut)
Set the value of the ObjectOut property.

Parameters:
objectOut - The value to be set.

getXmlIn

XMLString getXmlIn()
Fetch the XMLString that will be unmarshalled by the entry point. This is the input to the unmarshal process, and should represent an instance of the class specificed in ClassIn.

Returns:
The XMLString to be unmarshalled.

setXmlIn

void setXmlIn(XMLString xmIn)
Set the value of the XmlIn property.

Parameters:
xmlIn - The value to be set.

getClassIn

java.lang.Class getClassIn()
Get the value of the ClassIn argument. This argument specifies the class which XmlIn represents an instance of.

Returns:
The class to be unmarshalled into.

setClassIn

void setClassIn(java.lang.Class classIn)
Set the value of the ClassIn property.

Parameters:
classIn - The value to be set.

getXmlMappingInOut

XMLMapping getXmlMappingInOut()
Get the value of XmlMapping. This describes how to map from xml into java objects (and the reverse), and map be used by the service to cache marshallers and unmarshallers.

Returns:
The mapping, or null if it is not defined.

setXmlMappingInOut

void setXmlMappingInOut(XMLMapping xmlMapping)
Set the XML mapping property.

Parameters:
xmlMapping - The mapping to use.
See Also:
#getXmlMappingIn