org.openeai.moa
Class ActionableEnterpriseObjectBase

java.lang.Object
  org.openeai.OpenEaiObject
      org.openeai.moa.EnterpriseObjectBase
          org.openeai.moa.XmlEnterpriseObjectImpl
              org.openeai.moa.ActionableEnterpriseObjectBase

All Implemented Interfaces:

java.lang.Cloneable, ActionableEnterpriseObject, EnterpriseObject, XmlEnterpriseObject, PubliclyCloneable

public abstract class ActionableEnterpriseObjectBase
extends XmlEnterpriseObjectImpl
implements ActionableEnterpriseObject

Field Summary

Fields inherited from class org.openeai.moa.XmlEnterpriseObjectImpl

ENTERPRISE_FIELDS, XML_LAYOUT_MANAGER

Fields inherited from class org.openeai.OpenEaiObject

logger

Constructor Summary

ActionableEnterpriseObjectBase()

Method Summary

protected void	buildCreateMessage(org.jdom.Document createDoc) Using the current contents of the object along with the 'primed' XML document this method builds the acutal Enterprise Message.
protected void	buildDeleteMessage(java.lang.String deleteAction, org.jdom.Document deleteDoc) Using the current contents of the object along with the 'primed' XML document this method builds the acutal Enterprise Message.
protected abstract void	buildGenerateMessage(org.jdom.Document generateDoc, XmlEnterpriseObject keyObject)
protected void	buildQueryMessage(org.jdom.Document queryDoc, XmlEnterpriseObject keyObject) Using the current contents of the 'keyObject' passed in along with the 'primed' XML document this method builds the acutal Enterprise Message.
protected void	buildUpdateMessage(org.jdom.Document updateDoc) Using the current contents of the object along with the 'primed' XML document this method builds the acutal Enterprise Message.
XmlEnterpriseObject	create(RequestService producer) Create message production.
void	createSync(SyncService producer) Create Sync message production.
XmlEnterpriseObject	delete(java.lang.String deleteAction, RequestService producer) Delete message production.
void	deleteSync(java.lang.String deleteAction, SyncService producer) Delete Sync message production.
java.util.List	generate(XmlEnterpriseObject keyObject, RequestService producer) Generate message production.
Authentication	getAuthentication() Returns the Authentication object associated with this object.
java.lang.String	getCommandName() Returns the Command name associated with this object.
protected java.lang.String	getElementName() Abstract method that must be implemented by decendants so this object will know what element it's dealing with when building Xml documents.
java.util.List	getLastErrors() Returns a List containing the last errors encountered by this object during a Request action (create, query, generate, update, delete).
MessageId	getMessageId() Returns the MessageId object associated with this object.
XmlEnterpriseObject	getXmlEnterpriseObject() Helper method that returns this object as an XmlEnterpriseObject.
void	init(MessageObjectConfig mConfig) Object initialization.
java.util.List	query(XmlEnterpriseObject keyObject, RequestService producer) Query message production.
void	setAuthentication(Authentication auth) Sets the Authentication object associated with this object.
void	setCommandName(java.lang.String name) Sets the Command name associated with this object.
protected org.jdom.Element	setControlArea(org.jdom.Element controlArea)
void	setMessageId(MessageId msgId) Sets the MessageId object associated with this object.
XmlEnterpriseObject	update(RequestService producer) Update message production.
void	updateSync(SyncService producer) Update Sync message production.

Methods inherited from class org.openeai.moa.XmlEnterpriseObjectImpl

addInputLayoutManager, addOutputLayoutManager, buildObjectFromInput, buildObjectFromXmlString, buildOutputFromObject, buildOutputFromObject, clone, deferInitialization, dumpData, equals, getApplicationValue, getBaseline, getCombinedKeyValue, getControlArea, getCreateDoc, getCreateDocUri, getCreateSyncDoc, getCreateSyncDocUri, getDeleteDoc, getDeleteDocUri, getDeleteSyncDoc, getDeleteSyncDocUri, getEnterpriseFields, getEnterpriseValue, getGenerateDoc, getGenerateDocUri, getGenerateSyncDoc, getGenerateSyncDocUri, getInputLayoutManager, getInputLayoutManager, getInputLayoutManagers, getLength, getOutputLayoutManager, getOutputLayoutManager, getOutputLayoutManagers, getProvideDoc, getProvideDocUri, getQueryDoc, getQueryDocUri, getResponseDoc, getResponseDocUri, getRootElementName, getTestId, getUpdateDoc, getUpdateDocUri, getUpdateSyncDoc, getUpdateSyncDocUri, getValidation, getValueFromObject, getValueFromObject, initializeChild, isDate, isEmpty, isRepeating, restoreLayoutManagers, saveLayoutManagers, setBaseline, setCreateDoc, setCreateDocUri, setCreateSyncDoc, setCreateSyncDocUri, setDeleteDoc, setDeleteDocUri, setDeleteSyncDoc, setDeleteSyncDocUri, setEnterpriseFields, setGenerateDoc, setGenerateDocUri, setGenerateSyncDoc, setGenerateSyncDocUri, setInputLayoutManager, setInputLayoutManagers, setOutputLayoutManager, setOutputLayoutManagers, setProvideDoc, setProvideDocUri, setQueryDoc, setQueryDocUri, setResponseDoc, setResponseDocUri, setTestId, setUpdateDoc, setUpdateDocUri, setUpdateSyncDoc, setUpdateSyncDocUri, setValidation, setValue, toString, toXmlString

Methods inherited from class org.openeai.OpenEaiObject

getAppName, getDebug, getFromAddr, getMailHost, getMailService, getProperties, getToAddr, initializeLog4j, initializeLog4j, initializeLog4j, setAppName, setDebug, setFromAddr, setMailHost, setMailService, setProperties, setToAddr

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openeai.moa.XmlEnterpriseObject

addInputLayoutManager, addOutputLayoutManager, buildObjectFromInput, buildObjectFromXmlString, buildOutputFromObject, buildOutputFromObject, clone, equals, getBaseline, getCombinedKeyValue, getCreateDoc, getCreateSyncDoc, getDeleteDoc, getDeleteSyncDoc, getEnterpriseFields, getGenerateDoc, getGenerateSyncDoc, getInputLayoutManager, getInputLayoutManager, getInputLayoutManagers, getOutputLayoutManager, getOutputLayoutManager, getOutputLayoutManagers, getProvideDoc, getQueryDoc, getResponseDoc, getTestId, getUpdateDoc, getUpdateSyncDoc, getValidation, getValueFromObject, getValueFromObject, initializeChild, isDate, isEmpty, setBaseline, setCreateDoc, setCreateSyncDoc, setDeleteDoc, setDeleteSyncDoc, setEnterpriseFields, setGenerateDoc, setGenerateSyncDoc, setInputLayoutManager, setInputLayoutManagers, setOutputLayoutManager, setOutputLayoutManagers, setProvideDoc, setQueryDoc, setResponseDoc, setTestId, setUpdateDoc, setUpdateSyncDoc, toString, toXmlString

Constructor Detail

ActionableEnterpriseObjectBase

public ActionableEnterpriseObjectBase()

Method Detail

getXmlEnterpriseObject

public XmlEnterpriseObject getXmlEnterpriseObject()

Helper method that returns this object as an XmlEnterpriseObject.

Specified by:

getXmlEnterpriseObject in interface ActionableEnterpriseObject

Returns:

org.openeai.moa.XmlEnterpriseObject. This object cast to an XmlEnterpriseObject.

create

public final XmlEnterpriseObject create(RequestService producer)
                                 throws EnterpriseObjectCreateException

Create message production. Builds an XML document (using the primed create document as a "template") out of the current contents of the object. While building the XML Create document, it will validate contents of the object checking for any malformed, missing or invalid fields. Field data values are also checked for validitity against the EnterpriseObjects document. Uses the producer passed in to send the XML document as a JMS request to the queue connected to by the producer which then processes the response checking for any errors in the response.

Specified by:

create in interface ActionableEnterpriseObject

Parameters:

producer - PointToPointProducer a pre-configured and started PointToPointProducer which will be used to send the create-request message to the appropriate destination and return the reply to this method (via the PointToPointProducer.produceRequest method).

Returns:

XmlEnterpriseObject a generic response which will indicate success or failure. If failure, any error information will be included in that result. The object returned is actually a org.openeai.moa.objects.Result object.

Throws:

EnterpriseObjectCreateException - if any errors occur when validating the contents of the object, if any errors occur while producing the request or if the object doesn't support the create action. This exception will also be thrown if the contents of the reply document contains an error. That is, if the consuming application had errors processing the request. This exception will include the Result information containing the error that occurred.

createSync

public final void createSync(SyncService producer)
                      throws EnterpriseObjectSyncException

Create Sync message production. Builds an XML document (using the primed create sync document as a baseline) out of the current contents of the object. While building the XML Create Sync document, it will validate contents of the object checking for any malformed, missing or invalid fields. Field data values are also checked for validitity against the EnterpriseObjects document. Publishes the XML document in a JMS message to the topic connected to by producer.

Specified by:

createSync in interface ActionableEnterpriseObject

Parameters:

producer - org.openeai.jms.producer.PubSubProducer to use to publish the message.

Throws:

EnterpriseObjectSyncException - if any errors occur when validating the contents of the object. Or, if any errors occur while publishing the message.

buildCreateMessage

protected void buildCreateMessage(org.jdom.Document createDoc)
                           throws org.jdom.JDOMException,
                                  EnterpriseObjectCreateException

Using the current contents of the object along with the 'primed' XML document this method builds the acutal Enterprise Message. (e.g. - Person/BasicPerson-Create-Request or Person/BasicPerson-Create-Sync). This Enterprise Message will then be sent via JMS to a queue/topic and consumed by a Gateway which will process the request/sync and return a reply if appropriate. Note, replies will only be returned when a request message is sent.

Parameters:

createDoc - Document the 'primed' xml document for this action. (e.g. - a sample BasicPerson-Create-Request.xml document).

Throws:

EnterpriseObjectCreateException - if errors serializing the object as an Xml Element.

org.jdom.JDOMException - if errors occur manipulating the document.

update

public final XmlEnterpriseObject update(RequestService producer)
                                 throws EnterpriseObjectUpdateException

Update message production. Builds an XML document (using the primed update document as a "template") out of the current contents of the object (this). It will use the current contents of the object as the NewData portion of the message and it will use this object's "baseline" object as the Baseline portion of the message. The "baseline" object is set when this object was "queried" for previously. While building the XML Update message, it will validate contents checking for any malformed, missing or invalid fields. Field data values are also checked for validitity against the EnterpriseObjects document. Uses the producer passed in to send the XML document as a JMS request to the queue connected to by the producer which then processes the response checking for any errors in the response.

Specified by:

update in interface ActionableEnterpriseObject

Parameters:

producer - PointToPointProducer a pre-configured and started PointToPointProducer which will be used to send the update-request message to the appropriate destination and return the reply to this method (via the PointToPointProducer.produceRequest method).

Returns:

XmlEnterpriseObject (Result) this will indicate the success or failure of the Update request. In an error condition, this will include any error information.

Throws:

EnterpriseObjectUpdateException - if any errors occur when validating the contents of the object, if any errors occur while producing the request or if the object doesn't support the create action. This exception will also be thrown if the contents of the reply document contains an error. That is, if the consuming application had errors processing the request. This exception will include the Result information containing the error that occurred.

updateSync

public final void updateSync(SyncService producer)
                      throws EnterpriseObjectSyncException

Update Sync message production. Builds an XML document (using the primed update sync document as a "template") out of the current contents of the object. It will use the current contents of the object as the NewData portion of the message and it will use the m_baseline object as the Baseline portion of the message. The m_baseline object is set when this object was "queried" for previously. While building the XML Update Sync document, it will validate contents of the object checking for any malformed, missing or invalid fields. Field data values are also checked for validitity against the EnterpriseObjects document. Publishes the XML document in a JMS message to the topic connected to by producer.

Specified by:

updateSync in interface ActionableEnterpriseObject

Parameters:

producer - PubSubProducer a pre-configured and started PubSubProducer which will be used to send the delete-sync message to the appropriate destination (via the PubSubProducer.publishMessage method).

Throws:

EnterpriseObjectSyncException - if any errors occur when validating the contents of the object. Or, if any errors occur while publishing the message.

buildUpdateMessage

protected void buildUpdateMessage(org.jdom.Document updateDoc)
                           throws org.jdom.JDOMException,
                                  EnterpriseObjectUpdateException

Using the current contents of the object along with the 'primed' XML document this method builds the acutal Enterprise Message. (e.g. - Person/BasicPerson-Update-Request or Person/BasicPerson-Update-Sync). This Enterprise Message will then be sent via JMS to a queue/topic and consumed by a Gateway which will process the request/sync and return a reply if appropriate. Note, replies will only be returned when a request message is sent.

Parameters:

updateDoc - Document the 'primed' xml document for this action. (e.g. - a sample BasicPerson-Create-Request.xml document).

Throws:

EnterpriseObjectUpdateException - if errors serializing the object as an Xml Element.

org.jdom.JDOMException - if errors occur manipulating the document.

delete

public final XmlEnterpriseObject delete(java.lang.String deleteAction,
                                        RequestService producer)
                                 throws EnterpriseObjectDeleteException

Delete message production. Builds an XML document (using the primed delete document as a "template") out of the current contents of the object. While building the XML Delete document, it will validate contents of the object checking for any malformed, missing or invalid fields. Field data values are also checked for validitity against the EnterpriseObjects document. Uses the producer passed in to send the XML document as a JMS request to the queue connected to by the producer which then processes the response checking for any errors in the response.

Specified by:

delete in interface ActionableEnterpriseObject

Parameters:

deleteAction - String the delete action ('delete' or 'purge')

producer - PointToPointProducer a pre-configured and started PointToPointProducer which will be used to send the delete-request message to the appropriate destination and return the reply to this method (via the PointToPointProducer.produceRequest method).

Returns:

XmlEnterpriseObject a generic response which will indicate success or failure. If failure, any error information will be included in that result. The object returned is actually a org.openeai.moa.objects.Result object.

Throws:

EnterpriseObjectDeleteException - if any errors occur when validating the contents of the object, if any errors occur while producing the request or if the object doesn't support the create action. This exception will also be thrown if the contents of the reply document contains an error. That is, if the consuming application had errors processing the request. This exception will include the Result information containing the error that occurred.

deleteSync

public final void deleteSync(java.lang.String deleteAction,
                             SyncService producer)
                      throws EnterpriseObjectSyncException

Delete Sync message production. Builds an XML document (using the primed delete sync document as a baseline) out of the current contents of the object. While building the XML Delete Sync document, it will validate contents of the object checking for any malformed, missing or invalid fields. Field data values are also checked for validitity against the EnterpriseObjects document. Publishes the XML document in a JMS message to the topic connected to by producer.

Specified by:

deleteSync in interface ActionableEnterpriseObject

Parameters:

deleteAction - String delete action ('purge' or 'delete')

producer - PubSubProducer a pre-configured and started PubSubProducer which will be used to send the delete-sync message to the appropriate destination (via the PubSubProducer.publishMessage method).

Throws:

EnterpriseObjectSyncException - if any errors occur when validating the contents of the object. Or, if any errors occur while publishing the message.

buildDeleteMessage

protected void buildDeleteMessage(java.lang.String deleteAction,
                                  org.jdom.Document deleteDoc)
                           throws org.jdom.JDOMException,
                                  EnterpriseObjectDeleteException

Using the current contents of the object along with the 'primed' XML document this method builds the acutal Enterprise Message. (e.g. - Person/BasicPerson-Delete-Request or Person/BasicPerson-Delete-Sync). This Enterprise Message will then be sent via JMS to a queue/topic and consumed by a Gateway which will process the request/sync and return a reply if appropriate. Note, replies will only be returned when a request message is sent.

Parameters:

deleteDoc - Document the 'primed' xml document for this action. (e.g. - a sample BasicPerson-Create-Request.xml document).

Throws:

EnterpriseObjectDeleteException - if errors serializing the object as an Xml Element.

org.jdom.JDOMException - if errors occur manipulating the document.

query

public final java.util.List query(XmlEnterpriseObject keyObject,
                                  RequestService producer)
                           throws EnterpriseObjectQueryException

Query message production. Builds an XML document (using the primed query document as a "template") out of the current contents of the keyObject passed in. While building the XML Query message, it will validate contents of the keyObject checking for any malformed, missing or invalid fields. Field data values are also checked for validitity against the EnterpriseObjects document. Uses the producer passed in to send the XML document as a JMS request to the queue connected to by the producer which then processes the response checking for any errors in the response.

Specified by:

query in interface ActionableEnterpriseObject

Parameters:

keyObject - XmlEnterpriseObject to use as retreival arguments in the Query. The contents of this object are inserted into the Query document prior to sending the query request. Under normal conditions, this object is actually a LightweightPerson object since that's the most common query object used.

NOTE: This method should be over-ridden by lower level classes if the keyObject isn't a LightweightPerson.

producer - PointToPointProducer a pre-configured and started PointToPointProducer which will be used to send the update-request message to the appropriate destination and return the reply to this method (via the PointToPointProducer.produceRequest method).

Returns:

java.util.List this is a list of XmlEnterpriseObject objects (like BasicPerson, BasicEmployee etc.) provided by the authoritative source (the application consuming the query request).

Throws:

EnterpriseObjectQueryException - if any errors occur when validating the contents of the object, if any errors occur while producing the request or if the object doesn't support the create action. This exception will also be thrown if the contents of the reply document contains an error. That is, if the consuming application had errors processing the request. This exception will include the Result information containing the error that occurred.

buildQueryMessage

protected void buildQueryMessage(org.jdom.Document queryDoc,
                                 XmlEnterpriseObject keyObject)
                          throws org.jdom.JDOMException,
                                 EnterpriseObjectQueryException

Using the current contents of the 'keyObject' passed in along with the 'primed' XML document this method builds the acutal Enterprise Message. (e.g. - Person/BasicPerson-Query-Request). This Enterprise Message will then be sent via JMS to a queue/topic and consumed by a Gateway which will process the query request and return an appropriate provide-reply.

This method may be overridden by ancestors of JmsEnterpriseObject if they require a different 'keyObject' in the Query. (e.g. - InstituitonalIdentity requires an UnknownPerson instead of a LightweightPerson).

Parameters:

keyObject - XmlEnterpriseObject the 'keyObject' to be used in the Query. (e.g. - LightweightPerson)

queryDoc - Document the 'primed' xml document for this action. (e.g. - a sample BasicPerson-Create-Request.xml document).

Throws:

EnterpriseObjectQueryException - if errors serializing the object as an Xml Element.

org.jdom.JDOMException - if errors occur manipulating the document.

generate

public final java.util.List generate(XmlEnterpriseObject keyObject,
                                     RequestService producer)
                              throws EnterpriseObjectGenerateException

Generate message production. Builds an XML document (using the primed generate document as a "template") out of the current contents of the object. While building the XML Generate document, it will validate contents of the object checking for any malformed, missing or invalid fields. Field data values are also checked for validitity against the EnterpriseObjects document. Uses the producer passed in to send the XML document as a JMS request to the queue connected to by the producer which then processes the response checking for any errors in the response.

Specified by:

generate in interface ActionableEnterpriseObject

Parameters:

producer - PointToPointProducer a pre-configured and started PointToPointProducer which will be used to send the update-request message to the appropriate destination and return the reply to this method (via the PointToPointProducer.produceRequest method).

keyObject - XmlEnterpriseObject to use as generation "seed" data (like an UnknownPerson for an InstitutionalIdentity-Generate-Request).

Returns:

java.util.List this is a list of XmlEnterpriseObject objects generated by the authoritative source (the application consuming the request to generate). Typically, this will be only one object (like an InstitutionalIdentity).

Throws:

EnterpriseObjectGenerateException - if any errors occur when validating the contents of the object, if any errors occur while producing the request or if the object doesn't support the create action. This exception will also be thrown if the contents of the reply document contains an error. That is, if the consuming application had errors processing the request. This exception will include the Result information containing the error that occurred.

buildGenerateMessage

protected abstract void buildGenerateMessage(org.jdom.Document generateDoc,
                                             XmlEnterpriseObject keyObject)
                                      throws org.jdom.JDOMException,
                                             EnterpriseObjectGenerateException

Throws:

org.jdom.JDOMException

EnterpriseObjectGenerateException

getLastErrors

public java.util.List getLastErrors()

Returns a List containing the last errors encountered by this object during a Request action (create, query, generate, update, delete). When an error occurs during one of those actions, an exception is thrown. Therefore, the calling application doesn't have access to the errror objects in the result. This convenience method gives them access to those Error objects so they may use them accordingly in their application instead of having to parse the exception message etc.

Specified by:

getLastErrors in interface ActionableEnterpriseObject

Returns:

java.util.List the list of errors that were saved the last time this object had an error performing a request action.

setControlArea

protected org.jdom.Element setControlArea(org.jdom.Element controlArea)
                                   throws EnterpriseObjectException

Throws:

EnterpriseObjectException

init

public void init(MessageObjectConfig mConfig)
          throws EnterpriseObjectException

Object initialization. This method initializes the current object with information contained in the EnterpriseConfigurationObject passed in. All JmsEnterpriseObjects inherit this functionality and the init method is called when the AppConfig object is being built for a particular application. This method will never be called directly from an application. The call is "behind the scenes". The values stored in the config object passed in are retreived from the Application Deployment and EnterpriseObjects documents. This includes configuration information for things like: Primed Documents, Xml Validation, Enterprise field rules (translation, formats, scrubbing etc.) and Layout management. See the documentation for the Application Deployment and EnterpriseObjects Xml documents for more information on these items. More information can also be found in the JavaDoc for the org.openeai.config package.

Overrides:

init in class XmlEnterpriseObjectImpl

Parameters:

mConfig - MessageObjectConfig object loaded with all configuration information relative to this object built from the configuration document.

Throws:

EnterpriseObjectException - if errors occur initializing the current MessageObject.

See Also:

MessageObjectConfig, EnterpriseFields

getElementName

protected java.lang.String getElementName()

Abstract method that must be implemented by decendants so this object will know what element it's dealing with when building Xml documents.

Returns:

String the element name.

setMessageId

public final void setMessageId(MessageId msgId)

Sets the MessageId object associated with this object. This is a core part of all messages (in the ControlArea) and no message can be produced if this hasn't been set. However, this gets set when the Message Object is initialized via the init method and the MessageObjectConfig object. The information contained in the MessageId object is set based on contents of the MessagingEnterprise XML document which is used to initialize all message objects. No client application should ever need to call this method directly.

Specified by:

setMessageId in interface ActionableEnterpriseObject

Parameters:

msgId - MessageId

getMessageId

public final MessageId getMessageId()

Returns the MessageId object associated with this object. This is a core part of all messages (in the ControlArea) and no message can be produced if this hasn't been set. However, this gets set when the Message Object is initialized via the init method and the MessageObjectConfig object. The information contained in the MessageId object is set based on contents of the MessagingEnterprise XML document which is used to initialize all message objects. No client application should ever need to call this method directly.

Specified by:

getMessageId in interface ActionableEnterpriseObject

Returns:

MessageId the MessageId object associated with this object.

setAuthentication

public final void setAuthentication(Authentication auth)

Sets the Authentication object associated with this object. This is a core part of all messages (in the ControlArea) and no message can be produced if this hasn't been set. However, this gets set when the Message Object is initialized via the init method and the MessageObjectConfig object. The information contained in the Authentication object is set based on contents of the MessagingEnterprise XML document which is used to initialize all message objects. No client application should ever need to call this method directly.

Specified by:

setAuthentication in interface ActionableEnterpriseObject

Parameters:

auth - Authentication

getAuthentication

public final Authentication getAuthentication()

Returns the Authentication object associated with this object. This is a core part of all messages (in the ControlArea) and no message can be produced if this hasn't been set. However, this gets set when the Message Object is initialized via the init method and the MessageObjectConfig object. The information contained in the Authentication object is set based on contents of the MessagingEnterprise XML document which is used to initialize all message objects. No client application should ever need to call this method directly.

Specified by:

getAuthentication in interface ActionableEnterpriseObject

Returns:

Authentication the authentication object associated with this object.

setCommandName

public final void setCommandName(java.lang.String name)

Sets the Command name associated with this object. This is a core part of all messages (a property on the JMS message) and no message can be produced if this hasn't been set. However, this gets set when the Message Object is initialized via the init method and the MessageObjectConfig object. The Command Name is set based on contents of the application Deployment configuration document which is used to initialize all message objects. No client application should ever need to call this method directly. This is information that will be used by a consumer of the message to determine which "command" to execute when it receives the message. For more information on Commands and the University JMS Consumer framework refer to the JavaDoc for the org.openeai.jms.consumer package.

Specified by:

setCommandName in interface ActionableEnterpriseObject

Parameters:

name - String the name of the command as specified in the configuration document.

getCommandName

public final java.lang.String getCommandName()

Returns the Command name associated with this object. This is a core part of all messages (a property on the JMS message) and no message can be produced if either this hasn't been set. However, this gets set when the Message Object is initialized via the init method and the MessageObjectConfig object. The Command Name is set based on contents of the MessagingEnterprise XML document which is used to initialize all message objects. No client application should ever need to call this method directly. This is information that will be used by a consumer of the message to determine which "command" to execute when it receives the message. For more information on Commands and the University JMS Consumer framework refer to the JavaDoc for the org.openeai.jms.consumer package.

Specified by:

getCommandName in interface ActionableEnterpriseObject

Returns:

String message name associated with this object.