public interface BOXMLSerializer
The deserialization of the Business Document results in a BOXMLDocuemnt. From that document, the DataObject can be retrieved and utilized.
Note: Some of the operations take options, however, in the initial release of the product there are currently no supported options.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
static java.lang.String |
SCHEMALOCATION |
Modifier and Type | Method and Description |
---|---|
BOXMLDocument |
createXMLDocument(commonj.sdo.DataObject businessObject,
java.lang.String targetNamespace,
java.lang.String rootElementName)
Creates a BOXMLDocument representing a Business Document consisting of
a root element name and its target namespace, and the contained
DataObject.
|
BOXMLDocument |
readXMLDocument(java.io.InputStream inputStream)
Deserializes the Business Document from an input stream.
|
BOXMLDocument |
readXMLDocumentWithOptions(java.io.InputStream inputStream,
java.lang.Object options)
Deserializes the Business Document from an input stream with options.
|
void |
writeDataObject(commonj.sdo.DataObject businessObject,
java.lang.String targetNamespace,
java.lang.String rootElementName,
java.io.OutputStream outputStream)
Serializes the Business Document consisting of a root element name
and target namespace and the containing DataObject to the specified
output stream.
|
void |
writeDataObjectWithOptions(commonj.sdo.DataObject businessObject,
java.lang.String targetNamespace,
java.lang.String rootElementName,
java.io.OutputStream outputStream,
java.lang.Object options)
Serializes the Business Document consisting of a root element name
and target namespace and the containing DataObject to the specified
output stream with options.
|
void |
writeXMLDocument(BOXMLDocument businessDocument,
java.io.OutputStream outputStream)
Serializes the Business Document as a XML v1.0 stream to the
specified output stream.
|
void |
writeXMLDocumentWithOptions(BOXMLDocument businessDocument,
java.io.OutputStream outputStream,
java.lang.Object options)
Serializes the Business Document as a XML v1.0 stream to the
specified output stream with options.
|
static final java.lang.String COPYRIGHT
static final java.lang.String SCHEMALOCATION
BOXMLDocument createXMLDocument(commonj.sdo.DataObject businessObject, java.lang.String targetNamespace, java.lang.String rootElementName)
businessObject
- The DataObject portion of the Business DocumenttargetNamespace
- The target namespace of the Business DocumentrootElementName
- The root element name of the Business Documentvoid writeXMLDocument(BOXMLDocument businessDocument, java.io.OutputStream outputStream) throws java.io.IOException
businessDocument
- The Business Document to serializeoutputStream
- The target output stream for the XML v1.0 streamjava.io.IOException
void writeXMLDocumentWithOptions(BOXMLDocument businessDocument, java.io.OutputStream outputStream, java.lang.Object options) throws java.io.IOException
businessDocument
- The Business Document to serializeoutputStream
- The target output stream for the XML v1.0 streamoptions
- Serialization optionsjava.io.IOException
void writeDataObject(commonj.sdo.DataObject businessObject, java.lang.String targetNamespace, java.lang.String rootElementName, java.io.OutputStream outputStream) throws java.io.IOException
businessObject
- The Business ObjecttargetNamespace
- The target namespace of the Business DocumentrootElementName
- The root element name of the Business DocumentoutputStream
- The target output streamjava.io.IOException
void writeDataObjectWithOptions(commonj.sdo.DataObject businessObject, java.lang.String targetNamespace, java.lang.String rootElementName, java.io.OutputStream outputStream, java.lang.Object options) throws java.io.IOException
businessObject
- The Business ObjecttargetNamespace
- The target namespace of the Business DocumentrootElementName
- The root element name of the Business DocumentoutputStream
- The target output streamoptions
- Serialization optionsjava.io.IOException
BOXMLDocument readXMLDocument(java.io.InputStream inputStream) throws java.io.IOException
inputStream
- The source input streamjava.io.IOException
BOXMLDocument readXMLDocumentWithOptions(java.io.InputStream inputStream, java.lang.Object options) throws java.io.IOException
inputStream
- The source input streamoptions
- Deserialization optionsjava.io.IOException