org.openeai.moa
Interface XmlEnterpriseObject

All Superinterfaces:

EnterpriseObject

All Known Implementing Classes:

Authentication, ControlAreaReply, ControlAreaRequest, ControlAreaSync, Date, Datetime, Error, ExpectedReplyFormat, Failure, MessageId, MessageSeries, Predecessor, ProcessedMessageId, Result, Sender, SourceInfo, Success, TargetInfo, TestCaseSummary, TestId, TestResult, TestSeriesSummary, TestStatus, TestStepSummary, TestSuiteSummary, XmlEnterpriseObjectImpl

public interface XmlEnterpriseObject

extends EnterpriseObject

Placeholder for future interface..

Version:

3.0 beta2 - 28 January 2003

Author:

Tod Jackson (tod@openeai.org), Steve Wheat (steve@openeai.org)

Method Summary

void	addInputLayoutManager(java.lang.String type, EnterpriseLayoutManager iLayout)
void	addOutputLayoutManager(java.lang.String type, EnterpriseLayoutManager oLayout)
void	buildObjectFromInput(java.lang.Object input) Using the currently assigned input layout manager, this method takes the input passed in and builds the object from that input.
void	buildObjectFromXmlString(java.lang.String theString) This method allows application developers to build an object from a XML String representation of an object that was previously converted to an XML String via the toXmlString() method.
java.lang.Object	buildOutputFromObject() Using the currently assigned output layout manager, this method uses the current contents of the object and builds an output object as implemented by the layout manager.
java.lang.Object	buildOutputFromObject(java.lang.String appName) Using the currently assigned output layout manager, this method uses the current contents of the object and builds an output object as implemented by the layout manager for the specified application name.
java.lang.Object	clone() Performs a recursive field for field copy of the current Object and returns the result.
boolean	equals(XmlEnterpriseObject xeo) A convenience method that can be used to compare two Xml aware objects (XmlEnterpriseObjectImpl).
XmlEnterpriseObject	getBaseline() Returns the baseline object associated to this object.
java.lang.String	getCombinedKeyValue() goes through all the key fields on the xeo passed in and creates a string containing all the values from those key fields.
org.jdom.Document	getCreateDoc() Returns the "primed" Create Document associated with this object.
org.jdom.Document	getCreateSyncDoc() Returns the "primed" CreateSync Document associated with this object.
org.jdom.Document	getDeleteDoc() Returns the "primed" Delete Document associated with this object.
org.jdom.Document	getDeleteSyncDoc() Returns the "primed" DeleteSync Document associated with this object.
EnterpriseFields	getEnterpriseFields() Returns the EnterpriseFields object associated with this object.
org.jdom.Document	getGenerateDoc() Returns the "primed" generate Document associated with this object.
org.jdom.Document	getGenerateSyncDoc() Returns the "primed" GenerateSync Document associated with this object.
EnterpriseLayoutManager	getInputLayoutManager() Returns this object's currently assigned Input Layout manager.
EnterpriseLayoutManager	getInputLayoutManager(java.lang.String type) Returns an Input Layout manager for this object of a specified type.
java.util.HashMap	getInputLayoutManagers() Returns a HashMap containing all Input Layout managers associated to this object.
EnterpriseLayoutManager	getOutputLayoutManager() Returns this object's currently assigned Output Layout manager.
EnterpriseLayoutManager	getOutputLayoutManager(java.lang.String type) Returns an Output Layout manager for this object of a specified type.
java.util.HashMap	getOutputLayoutManagers() Returns a HashMap containing all Output Layout managers associated to this object.
org.jdom.Document	getProvideDoc() Returns the "primed" Provide Document associated with this object.
org.jdom.Document	getQueryDoc() Returns the "primed" Query Document associated with this object.
org.jdom.Document	getResponseDoc() Returns the "primed" Response Document associated with this object.
TestId	getTestId() Returns the test id associated to this object.
org.jdom.Document	getUpdateDoc() Returns the "primed" Update Document associated with this object.
org.jdom.Document	getUpdateSyncDoc() Returns the "primed" UpdateSync Document associated with this object.
java.lang.Object	getValueFromObject(java.lang.String fieldName) Returns the current value from the field name passed in.
java.lang.Object	getValueFromObject(java.lang.String fieldName, java.lang.Object[] parms, java.lang.Class[] parmTypes) Returns the current value from the field name passed in.
boolean	isDate() Checks to see if this object is a "Date/Datetime" object.
boolean	isEmpty() Recursively checks the contents of the object and true if it contains any data.
void	setBaseline(XmlEnterpriseObject baseline) Sets the baseline object associated to this object.
void	setCreateDoc(org.jdom.Document doc) Sets the "primed" create document associated with this object.
void	setCreateSyncDoc(org.jdom.Document doc) Sets the "primed" create sync document associated with this object.
void	setDeleteDoc(org.jdom.Document doc) Sets the "primed" delete document associated with this object.
void	setDeleteSyncDoc(org.jdom.Document doc) Sets the "primed" delete sync document associated with this object.
void	setEnterpriseFields(EnterpriseFields fields) Sets the EnterpriseFields object associated with this object.
void	setGenerateDoc(org.jdom.Document doc) Sets the "primed" generate document associated with this object.
void	setGenerateSyncDoc(org.jdom.Document doc) Sets the "primed" generate sync document associated with this object.
void	setInputLayoutManager(EnterpriseLayoutManager elm)
void	setInputLayoutManagers(java.util.HashMap iManagers)
void	setOutputLayoutManager(EnterpriseLayoutManager elm)
void	setOutputLayoutManagers(java.util.HashMap oManagers)
void	setProvideDoc(org.jdom.Document doc) Sets the "primed" provide document associated with this object.
void	setQueryDoc(org.jdom.Document doc) Sets the "primed" query document associated with this object.
void	setResponseDoc(org.jdom.Document doc) Sets the "primed" response document associated with this object.
void	setTestId(TestId tId) Sets the test id associated to this object.
void	setUpdateDoc(org.jdom.Document doc) Sets the "primed" update document associated with this object.
void	setUpdateSyncDoc(org.jdom.Document doc) Sets the "primed" update sync document associated with this object.
java.lang.String	toString() Returns a comma separated String containing all the data currently stored in this object.
java.lang.String	toXmlString() A convenience method that can be used simply by application developers to retreive the contents of the object as an XML String.

Method Detail

buildObjectFromInput

public void buildObjectFromInput(java.lang.Object input)
                          throws EnterpriseLayoutException

Using the currently assigned input layout manager, this method takes the input passed in and builds the object from that input. For example, if the data passed in is a BasicPerson XML Element, and the current inputLayoutManager is the XmlLayout manager, it will ask the layout manager to build the BasicPerson object from that element. The layout manager will then take the data in the element and put it into the appropriate instance variables (via object getter/setter methods). While it's doing that, the input data will be validated based on business rules found in the EnterpriseFields object (built from EnterpriseObjects.xml)

Additionally, if the data passed in is "application specific" data (like codes) this data will be converted to Enterprise Values based on Translation information also obtained from the EnterpriseObjects.xml document.

This method (along with buildOutputFromObject and the Layout Manager infrastructure) allows us to generalize the building our message objects so we don't have to put all of that logic in the objects themselves. We just implement new Layout Managers and associate those layouts to the objects. All objects have an Xml Layout Manager associated to them that is derived from the EnterpriseObjects.xml document.

Throws:

EnterpriseLayoutException. - If an error occurs building the object from the data passed in.

EnterpriseLayoutException

buildOutputFromObject

public java.lang.Object buildOutputFromObject()
                                       throws EnterpriseLayoutException

Using the currently assigned output layout manager, this method uses the current contents of the object and builds an output object as implemented by the layout manager. For example, if the object is a BasicPerson, and the current outputLayoutManager is the XmlLayout manager, it will ask the layout manager to build the BasicPerson XML Element from BasicPerson object. The layout manager will then retrieve the data from the BasicPerson object via object getter methods and build an Element from the data. While it's doing that, the object will be validated based on business rules found in the EnterpriseFields object (built from EnterpriseObjects.xml)

This method (along with buildInputFromObject and the Layout Manager infrastructure) allows us to generalize the serialization our message objects so we don't have to put all of that logic in the objects themselves. We just implement new Layout Managers and associate those layouts to the objects. All objects have an Xml Layout Manager associated to them that is derived from the EnterpriseObjects.xml document.

Returns:

Object the data that will be built from the object. The calling applicatons will cast this object to the appropriate thing. e.g. - Element, String etc.

Throws:

EnterpriseLayoutException. - If an error occurs building the output from the object.

EnterpriseLayoutException

buildOutputFromObject

public java.lang.Object buildOutputFromObject(java.lang.String appName)
                                       throws EnterpriseLayoutException

Using the currently assigned output layout manager, this method uses the current contents of the object and builds an output object as implemented by the layout manager for the specified application name. For example, if the object is a BasicPerson, and the current outputLayoutManager is the ExtractLayout manager, it will ask the layout manager to build an extract line with application specific values using the contents of the BasicPerson object. This allows us to "reverse translate" our enterprise values to application specific values (like codes etc.) The information related to these translations can be found in the EnterpriseObjects.xml document.

This method (along with buildInputFromObject and the Layout Manager infrastructure) allows us to generalize the serialization our message objects so we don't have to put all of that logic in the objects themselves. We just implement new Layout Managers and associate those layouts to the objects. All objects have an Xml Layout Manager associated to them that is derived from the EnterpriseObjects.xml document.

Returns:

Object the data that will be built from the object. The calling applicatons will cast this object to the appropriate thing. e.g. - Element, String etc.

Throws:

EnterpriseLayoutException. - If an error occurs building the output from the object.

EnterpriseLayoutException

buildObjectFromXmlString

public void buildObjectFromXmlString(java.lang.String theString)
                              throws XmlEnterpriseObjectException

This method allows application developers to build an object from a XML String representation of an object that was previously converted to an XML String via the toXmlString() method. This method basically uses the "xml" inputLayoutManager to build the object from an Element that gets created out of the String passed in. This is so developers don't have to convert the String to an element themselves (as a convenience). They just have to pass the String and this method takes care of converting it to an Element and asking the layout manager to build the object from that element.

Throws:

XmlEnterpriseObjectException. - If an error occurs building the object from the data passed in.

XmlEnterpriseObjectException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Performs a recursive field for field copy of the current Object and returns the result. Any object found that supports the "clone" method is cloned. Since all simple fields within an XmlEnterpriseObjectImpl are ultimately Strings, the resulting object is in fact a new object because the copy is recursive.

Returns:

XmlEnterpriseObject a "deep" copy of the object.

java.lang.CloneNotSupportedException

getEnterpriseFields

public EnterpriseFields getEnterpriseFields()

Returns the EnterpriseFields object associated with this object. For information on the EnterpriseFields object, refer to the JavaDoc for the org.openeai.config package.

Returns:

EnterpriseFields the EnterpriseFields object that will be used by this object to validate/format data passed to setter methods on this object.

See Also:

EnterpriseFields

setEnterpriseFields

public void setEnterpriseFields(EnterpriseFields fields)

Sets the EnterpriseFields object associated with this object. For information on the EnterpriseFields object, refer to the JavaDoc for the org.openeai.config package. This is called when the object is initialized. The EnterpriseFields object is built based on information found in the EnterpriseObjects document.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

See Also:

EnterpriseFields

setTestId

public void setTestId(TestId tId)

Sets the test id associated to this object. This is used during testing to correlate a message sent by a particular object to a message consumed by a gateway. This is related to the OpenEAI Test Suite foundation.

getTestId

public TestId getTestId()

Returns the test id associated to this object. This is used during testing to correlate a message sent by a particular object to a message consumed by a gateway. This is related to the OpenEAI Test Suite foundation.

setBaseline

public void setBaseline(XmlEnterpriseObject baseline)

Sets the baseline object associated to this object. The baseline object is populated by all objects when that object performs a Query action via the JmsEnterpriseObject.query method. Then, when updates are performed on the object and an Update-Request/Sync is made on behalf of the object (via the JmsEnterpriseObject.update/updateSync method, it uses the baseline object to populate the DataArea/BaselineData element in the update document. The baseline object remains untouched during the processing on the main object.

getBaseline

public XmlEnterpriseObject getBaseline()

Returns the baseline object associated to this object. The baseline object is populated by all objects when that object performs a Query action via the JmsEnterpriseObject.query method. Then, when updates are performed on the object and an Update-Request/Sync is made on behalf of the object (via the JmsEnterpriseObject.update/updateSync method, it uses the baseline object to populate the DataArea/BaselineData element in the update document. The baseline object remains untouched during the processing on the main object.

Returns:

XmlEnterpriseObject the baseline object (e.g. - BasicPerson) that is an image of the object at the time of the Query.

getInputLayoutManager

public EnterpriseLayoutManager getInputLayoutManager()

Returns this object's currently assigned Input Layout manager. If no current input layout manager exists, it returns the XmlLayout manager that all objects must have.

Returns:

EnterpriseLayoutManager the currently assigned input layout manager. if no input layout manager has been assigned, it returns the XmlLayout manager.

getInputLayoutManagers

public java.util.HashMap getInputLayoutManagers()

Returns a HashMap containing all Input Layout managers associated to this object. These are all the input layout managers that may be used by this object. Since objects may support several different layout managers that are used to build themselves, this is necessary.

Returns:

HashMap the list of Input Layout managers that may be used by this object.

getInputLayoutManager

public EnterpriseLayoutManager getInputLayoutManager(java.lang.String type)

Returns an Input Layout manager for this object of a specified type. (e.g. - "xml", "extract"). If no layout manager of the specified type exists, it returns null.

Returns:

EnterpriseLayoutManager the input layout manager that is the type specified as a parm.

setInputLayoutManagers

public void setInputLayoutManagers(java.util.HashMap iManagers)

addInputLayoutManager

public void addInputLayoutManager(java.lang.String type,
                                  EnterpriseLayoutManager iLayout)

setInputLayoutManager

public void setInputLayoutManager(EnterpriseLayoutManager elm)

getOutputLayoutManagers

public java.util.HashMap getOutputLayoutManagers()

Returns a HashMap containing all Output Layout managers associated to this object. These are all the output layout managers that may be used by this object. Since objects may support several different layout managers that are used to serialize themselves, this is necessary.

Returns:

HashMap the list of Output Layout managers that may be used by this object.

getOutputLayoutManager

public EnterpriseLayoutManager getOutputLayoutManager()

Returns this object's currently assigned Output Layout manager. If no current output layout manager exists, it returns the XmlLayout manager that all objects must have.

Returns:

EnterpriseLayoutManager the currently assigned output layout manager. if no output layout manager has been assigned, it returns the XmlLayout manager.

getOutputLayoutManager

public EnterpriseLayoutManager getOutputLayoutManager(java.lang.String type)

Returns an Output Layout manager for this object of a specified type. (e.g. - "xml", "extract"). If no layout manager of the specified type exists, it returns null.

Returns:

EnterpriseLayoutManager the output layout manager that is the type specified as a parm.

setOutputLayoutManagers

public void setOutputLayoutManagers(java.util.HashMap oManagers)

addOutputLayoutManager

public void addOutputLayoutManager(java.lang.String type,
                                   EnterpriseLayoutManager oLayout)

setOutputLayoutManager

public void setOutputLayoutManager(EnterpriseLayoutManager elm)

isEmpty

public boolean isEmpty()
                throws XmlEnterpriseObjectException

Recursively checks the contents of the object and true if it contains any data. Otherwise, it returns false. For example, if the BasicPerson/Name/FirstName variable has data in it, this method will return true. If no instance variables, or child objects have data in them, it returns false.

Returns:

boolean an indicator specifying whether or not the object is empty.

Throws:

XmlEnterpriseObjectException - if any errors occur when determining if the object empty.

isDate

public boolean isDate()

Checks to see if this object is a "Date/Datetime" object. This is because Dates and Datetimes contain special constructors that indicate the type of Date/Datetime being built and several other foundation components need to determine if an object being dealt with is one of those Date/Datetime objects.

Returns:

boolean

equals

public boolean equals(XmlEnterpriseObject xeo)
               throws XmlEnterpriseObjectException

A convenience method that can be used to compare two Xml aware objects (XmlEnterpriseObjectImpl). This method converts the current object and the object passed in to an XML String via the toXmlString() method. Then it does a String comparison on those two strings. Note, this method IS case sensitive.

Returns:

boolean

Throws:

XmlEnterpriseObjectException. - If an error occurs serializing the object to a String. This is usually due to invalid data (formats etc.) determined from the object's current rules as specified in EnterpriseFields.

XmlEnterpriseObjectException

toString

public java.lang.String toString()

Returns a comma separated String containing all the data currently stored in this object.

Format for returned data:

FieldName1=some value, FieldName2=field2 data etc.

Overrides:

toString in class java.lang.Object

Returns:

String

toXmlString

public java.lang.String toXmlString()
                             throws XmlEnterpriseObjectException

A convenience method that can be used simply by application developers to retreive the contents of the object as an XML String. Basically, this is a fully valid XML Element just represented as a String. This data can then be used to persist the entire object, and/or build an Element from that String which can be used to build the object from an input (an XML Element).

Returns:

String the XML representation of the object as a String.

Throws:

XmlEnterpriseObjectException. - If an error occurs serializing the object to a String. This is usually due to invalid data (formats etc.) determined from the object's current rules as specified in EnterpriseFields.

XmlEnterpriseObjectException

getCombinedKeyValue

public java.lang.String getCombinedKeyValue()
                                     throws XmlEnterpriseObjectException

goes through all the key fields on the xeo passed in and creates a string containing all the values from those key fields. This string is used by other methods to determine if there are matching new/baseline xeos with the same key information. That allows us to determine if a transaction should be an insert, update, delete or ignored.

Returns:

String the combined key value

Throws:

XmlEnterpriseObjectException

getValueFromObject

public java.lang.Object getValueFromObject(java.lang.String fieldName)
                                    throws XmlEnterpriseObjectException

Returns the current value from the field name passed in. Convenience method to allow "reflective" use of XmlEnterpriseObjects. Assumes the getter method being called does not take any parameters.

Returns:

Object the value from the field

Throws:

XmlEnterpriseObjectException - if the field name passed in does not exist or if any other errors occur calling the getter method associated to the field.

getValueFromObject

public java.lang.Object getValueFromObject(java.lang.String fieldName,
                                           java.lang.Object[] parms,
                                           java.lang.Class[] parmTypes)
                                    throws XmlEnterpriseObjectException

Returns the current value from the field name passed in. Convenience method to allow "reflective" use of XmlEnterpriseObjects. Allows for parameters. This is especially neccessary when retrieving an individual object from a list of objects contained within the parent object.

Returns:

Object the value from the field

Throws:

XmlEnterpriseObjectException - if the field name passed in does not exist or if any other errors occur calling the getter method associated to the field.

getCreateDoc

public org.jdom.Document getCreateDoc()

Returns the "primed" Create Document associated with this object. This document is used as a baseline for create message production. This is valuable because we can populate the primed document with information that will not change and the message production logic doesn't have to worry about filling that information in prior to sending the message. Clients should never need to call this method directly unless they just want to know if the object has a primed create document associated to it.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed create document. Returns null if the document is null.

setCreateDoc

public void setCreateDoc(org.jdom.Document doc)

Sets the "primed" create document associated with this object. This is called during object initialization and is set based on information in the deployment document. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" create Document

getCreateSyncDoc

public org.jdom.Document getCreateSyncDoc()

Returns the "primed" CreateSync Document associated with this object. This document is used as a baseline for CreateSync message production. This is valuable because we can populate the primed document with information that will not change and the message production logic doesn't have to worry about filling that information in prior to sending the message. Clients should never need to call this method directly unless they just want to know if the object has a primed create sync document associated to it.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed CreateSync document. Returns null if the document is null.

setCreateSyncDoc

public void setCreateSyncDoc(org.jdom.Document doc)

Sets the "primed" create sync document associated with this object. This is called during object initialization and is set based on information in the MessagingEnterprise document. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" create sync Document

getDeleteDoc

public org.jdom.Document getDeleteDoc()

Returns the "primed" Delete Document associated with this object. This document is used as a baseline for delete message production. This is valuable because we can populate the primed document with information that will not change and the message production logic doesn't have to worry about filling that information in prior to sending the message. Clients should never need to call this method directly unless they just want to know if the object has a primed delete document associated to it.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed delete document. Returns null if the document is null.

setDeleteDoc

public void setDeleteDoc(org.jdom.Document doc)

Sets the "primed" delete document associated with this object. This is called during object initialization and is set based on information in the MessagingEnterprise document. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" delete Document

getDeleteSyncDoc

public org.jdom.Document getDeleteSyncDoc()

Returns the "primed" DeleteSync Document associated with this object. This document is used as a baseline for DeleteSync message production. This is valuable because we can populate the primed document with information that will not change and the message production logic doesn't have to worry about filling that information in prior to sending the message. Clients should never need to call this method directly unless they just want to know if the object has a primed delete sync document associated to it.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed DeleteSync document. Returns null if the document is null.

setDeleteSyncDoc

public void setDeleteSyncDoc(org.jdom.Document doc)

Sets the "primed" delete sync document associated with this object. This is called during object initialization and is set based on information in the MessagingEnterprise document. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" delete sync Document

getGenerateDoc

public org.jdom.Document getGenerateDoc()

Returns the "primed" generate Document associated with this object. This document is used as a baseline for generate message production. This is valuable because we can populate the primed document with information that will not change and the message production logic doesn't have to worry about filling that information in prior to sending the message. Clients should never need to call this method directly unless they just want to know if the object has a primed generate document associated to it.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed generate document. Returns null if the document is null.

setGenerateDoc

public void setGenerateDoc(org.jdom.Document doc)

Sets the "primed" generate document associated with this object. This is called during object initialization and is set based on information in the MessagingEnterprise document. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" generate Document

setGenerateSyncDoc

public void setGenerateSyncDoc(org.jdom.Document doc)

Sets the "primed" generate sync document associated with this object. This is called during object initialization and is set based on information in the MessagingEnterprise document. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" generate sync Document

getGenerateSyncDoc

public org.jdom.Document getGenerateSyncDoc()

Returns the "primed" GenerateSync Document associated with this object. This document is used as a baseline for GenerateSync message production. This is valuable because we can populate the primed document with information that will not change and the message production logic doesn't have to worry about filling that information in prior to sending the message. Clients should never need to call this method directly unless they just want to know if the object has a primed generate sync document associated to it.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed GenerateSync document. Returns null if the document is null.

getUpdateDoc

public org.jdom.Document getUpdateDoc()

Returns the "primed" Update Document associated with this object. This document is used as a baseline for update message production. This is valuable because we can populate the primed document with information that will not change and the message production logic doesn't have to worry about filling that information in prior to sending the message. Clients should never need to call this method directly unless they just want to know if the object has a primed update document associated to it.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed update document.

setUpdateDoc

public void setUpdateDoc(org.jdom.Document doc)

Sets the "primed" update document associated with this object. This is called during object initialization and is set based on information in the MessagingEnterprise document. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" update Document

getUpdateSyncDoc

public org.jdom.Document getUpdateSyncDoc()

Returns the "primed" UpdateSync Document associated with this object. This document is used as a baseline for UpdateSync message production. This is valuable because we can populate the primed document with information that will not change and the message production logic doesn't have to worry about filling that information in prior to sending the message. Clients should never need to call this method directly unless they just want to know if the object has a primed update sync document associated to it.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed UpdateSync document.

setUpdateSyncDoc

public void setUpdateSyncDoc(org.jdom.Document doc)

Sets the "primed" update sync document associated with this object. This is called during object initialization and is set based on information in the MessagingEnterprise document. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" update sync Document

getProvideDoc

public org.jdom.Document getProvideDoc()

Returns the "primed" Provide Document associated with this object. This document can be used by gateways who consume Query-Requests for this object as a baseline for Provide-Reply messages. This way, the gateway doesn't have to support any complex mapping in the gateway itself. Although some gateways may still choose to do it that way.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed provide document.

setProvideDoc

public void setProvideDoc(org.jdom.Document doc)

Sets the "primed" provide document associated with this object. This is called during object initialization and is set based on information in the Deployment descriptor. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" provide Document

getResponseDoc

public org.jdom.Document getResponseDoc()

Returns the "primed" Response Document associated with this object. This document can be used by gateways who consume Create, Delete and Update Requests for this object as a baseline for Response-Reply messages. This way, the gateway doesn't have to support any complex mapping in the gateway itself. Although some gateways may still choose to do it that way.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed provide document.

setResponseDoc

public void setResponseDoc(org.jdom.Document doc)

Sets the "primed" response document associated with this object. This is called during object initialization and is set based on information in the Deployment descriptor. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" response Document

getQueryDoc

public org.jdom.Document getQueryDoc()

Returns the "primed" Query Document associated with this object. This document is used as a baseline for Query message production. This is valuable because we can populate the primed document with information that will not change and the message production logic doesn't have to worry about filling that information in prior to sending the message. Clients should never need to call this method directly unless they just want to know if the object has a primed query document associated to it.

If the document is not initialized because of deferred initialization, the document will be initialized in this method and then it will be returned. This way, document initialization will only ever have to happen once and it can be configured to do it when an application starts or when the document is first requested.

Returns:

Document the primed Query document. Returns null if the document is null.

setQueryDoc

public void setQueryDoc(org.jdom.Document doc)

Sets the "primed" query document associated with this object. This is called during object initialization and is set based on information in the MessagingEnterprise document. Clients should never need to call this method directly unless they want to override the primed document that was associated to the object when it was initialized.

This information is specified in the MessageObjectConfig XML Element in the deployment documents and is passed to this object during initialization by the MessageObjectConfig Java object.

Parameters:

doc - org.jdom.Document the "primed" query Document