|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.b2bcommerce.invoice.pipeline.GenerateInvoiceMessage
public class GenerateInvoiceMessage
Pipeline processor that can generate an InvoiceMessage using virtually any class as the underlying dynamo message bean.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
static int[] |
RETCODES
|
protected static java.util.ResourceBundle |
sDefaultResources
|
static int |
SUCCESS
|
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.service.pipeline.PipelineProcessor |
---|
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
GenerateInvoiceMessage()
|
Method Summary | |
---|---|
protected int |
getErrorReturnCode()
Return the value that the pipeline processor should return to the pipeline chain in case of error. |
InvoiceTools |
getInvoiceTools()
Get the InvoiceTools component used to generate message objects. |
java.lang.String |
getMessageBeanClass()
Return the class to use for the dynamo message bean carrying the ObjectMessage data. |
java.util.Properties |
getMessageBeanPropertyMap()
Get the mapping table that controls mapping of property values from repository items to dynamo message beans. |
java.lang.String |
getMessagePort()
Return the JMS port for which messages will be generated. |
MessageSourceContext |
getMessageSourceContext()
|
java.lang.String |
getMessageType()
Return the JMS message type string to apply to generated messages. |
int[] |
getRetCodes()
Return all possible return values for this processor. |
boolean |
isAddProfileToMessageBean()
Query whether to automatically try to add the user profile to the dynamo message bean. |
boolean |
isEnabled()
Query whether sending messages from this process is enabled or disabled. |
boolean |
isMessageSourceStarted()
|
protected boolean |
isReady()
Check to see if this processor is ready to generate messages. |
boolean |
isRollbackOnError()
Query whether failure to deliver a message is considered a fatal error. |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
Generate and send a JMS ObjectMessage for the invoice that appears in the pipeline arguments. |
void |
setAddProfileToMessageBean(boolean pAddProfile)
Specify whether to automatically try to add the user profile to the dynamo message bean. |
void |
setEnabled(boolean pEnabled)
Enable or disable sending messages from this pipeline processor. |
void |
setInvoiceTools(InvoiceTools pInvoiceTools)
Set the InvoiceTools component used to generate message objects. |
void |
setMessageBeanClass(java.lang.String pMessageBeanClass)
Specify the class to use for the dynamo message bean carrying the ObjectMessage data. |
void |
setMessageBeanPropertyMap(java.util.Properties pMessageBeanPropertyMap)
Set the mapping table that controls mapping of property values from repository items to dynamo message beans whose class is specified by messageBeanClass . |
void |
setMessagePort(java.lang.String pMessagePort)
Set the JMS port for which messages will be generated. |
void |
setMessageSourceContext(MessageSourceContext pContext)
This notifies the MessageSource as to what its MessageSourceContext should be. |
void |
setMessageType(java.lang.String pMessageType)
Set the JMS message type string to apply to generated messages. |
void |
setRollbackOnError(boolean pRollbackOnError)
Specify whether or failure to deliver a message is considered a fatal error. |
void |
startMessageSource()
This is called to tell the MessageSource that it may begin sending messages. |
void |
stopMessageSource()
This is called to tell the MessageSource that it should stop sending messages. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final int SUCCESS
public static final int[] RETCODES
protected static java.util.ResourceBundle sDefaultResources
Constructor Detail |
---|
public GenerateInvoiceMessage()
Method Detail |
---|
public void setInvoiceTools(InvoiceTools pInvoiceTools)
public InvoiceTools getInvoiceTools()
public void setEnabled(boolean pEnabled)
public boolean isEnabled()
public void setRollbackOnError(boolean pRollbackOnError)
public boolean isRollbackOnError()
public void setMessageBeanClass(java.lang.String pMessageBeanClass)
InvoiceTools.defaultInvoiceMessageClass
.
InvoiceTools
public java.lang.String getMessageBeanClass()
public void setMessageBeanPropertyMap(java.util.Properties pMessageBeanPropertyMap)
messageBeanClass
. If no value is specified, a default
value will be derived from InvoiceTools.defaultInvoiceMessageMap
.
InvoiceTools
public java.util.Properties getMessageBeanPropertyMap()
public void setMessageType(java.lang.String pMessageType)
public java.lang.String getMessageType()
public void setMessagePort(java.lang.String pMessagePort)
public java.lang.String getMessagePort()
public void setAddProfileToMessageBean(boolean pAddProfile)
profile
whose type is RepositoryItem
,
then the profile property will be set to the user profile of the use who
placed the order resulting in the creation of the invoice being processed.
Otherwise no special attempt will be made to populate the profile property
of the message bean, even if it exists.
InvoiceTools
public boolean isAddProfileToMessageBean()
public void setMessageSourceContext(MessageSourceContext pContext)
MessageSource
setMessageSourceContext
in interface MessageSource
public MessageSourceContext getMessageSourceContext()
public void startMessageSource()
MessageSource
startMessageSource
in interface MessageSource
public void stopMessageSource()
MessageSource
stopMessageSource
in interface MessageSource
public boolean isMessageSourceStarted()
public int runProcess(java.lang.Object pParam, PipelineResult pResult)
messageBeanClass
,
will be generated on the port specified by messagePort
,
and will have its JMS message type set to the string specified by
messageBeanType
.
runProcess
in interface PipelineProcessor
pParam
- Pipeline parameters, which should be an instance of InvoicePipelineArgs.pResult
- Standard pipeline result object.
protected boolean isReady()
protected int getErrorReturnCode()
rollbackOnError
property.
public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |