atg.epub.servlet
Class FireWorkflowOutcomeFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.epub.servlet.PortletFormHandler
              atg.epub.servlet.PublishingPortletFormHandler
                  atg.epub.servlet.FireWorkflowOutcomeFormHandler

All Implemented Interfaces:

atg.droplet.ObjectFormHandler, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class FireWorkflowOutcomeFormHandler
extends PublishingPortletFormHandler

Form Handler for firing an outcome on a task in a workflow. Firing an outcome advances the workflow to the next task.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.epub.servlet.PublishingPortletFormHandler

mProcess, mProject, sConfiguration, sProcessHome, sProcessTaskInfoHome, sProjectHome

Fields inherited from class atg.epub.servlet.PortletFormHandler

mFormExceptions, PARAM_USE_FORWARDS, sTransactionManager

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

FireWorkflowOutcomeFormHandler()

Method Summary

java.lang.String	getActionNote()
java.lang.String	getFireWorkflowOutcome()
java.lang.String	getOutcomeElementId()
java.lang.String	getOutcomeInfoMessage()
java.lang.String	getTaskElementId()
void	handleFireWorkflowOutcome(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Handle method to fire the specified workflow outcome element.
void	handleFireWorkflowOutcome(javax.portlet.PortletRequest pRequest, javax.portlet.PortletResponse pResponse) Handle method to manage portlet requests.
protected boolean	isCurrentTransactionRolledBack(javax.transaction.TransactionManager pTransactionManager) Returns true if the current transaction is marked for rollback.
void	postFireWorkflowOutcome(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) No-op method meant for subclassing to add user specific functionality after handleFireWorkflowOutcome is called.
void	preFireWorkflowOutcome(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) No-op method meant for subclassing to add user specific functionality before handleFireWorkflowOutcome is called.
void	setActionNote(java.lang.String string)
void	setFireWorkflowOutcome(java.lang.String string)
void	setOutcomeElementId(java.lang.String string)
void	setOutcomeInfoMessage(java.lang.String pOutcomeInfoMessage)
void	setTaskElementId(java.lang.String pTaskElementId)

Methods inherited from class atg.epub.servlet.PublishingPortletFormHandler

getConfiguration, getCurrentDynamoRequest, getCurrentDynamoResponse, getProcess, getProcessHome, getProcessId, getProcessTaskInfoHome, getProject, getProjectHome, getProjectId, getResource, getResource, getResource, getResource, getWorkflowView, setProcessId, setProjectId, setWorkflowView

Methods inherited from class atg.epub.servlet.PortletFormHandler

addFormException, afterGet, afterGet, afterGet, afterSet, afterSet, afterSet, beforeGet, beforeGet, beforeGet, beforeSet, beforeSet, beforeSet, checkFormRedirect, getCheckForValidSession, getFormError, getFormExceptions, getPropertyExceptions, getTransactionDemarcation, handleFormException, handleUncheckedFormException, hasFormExceptions, isEnsureTransaction, isRestorableForm, isRollbackTransaction, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCheckForValidSession, setEnsureTransaction, setRestorableForm, setRollbackTransaction, setTransactionDemarcation, setUseForwards

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

FireWorkflowOutcomeFormHandler

public FireWorkflowOutcomeFormHandler()

Method Detail

getTaskElementId

public java.lang.String getTaskElementId()

setTaskElementId

public void setTaskElementId(java.lang.String pTaskElementId)

getOutcomeElementId

public java.lang.String getOutcomeElementId()

setOutcomeElementId

public void setOutcomeElementId(java.lang.String string)

getFireWorkflowOutcome

public java.lang.String getFireWorkflowOutcome()

setFireWorkflowOutcome

public void setFireWorkflowOutcome(java.lang.String string)

getActionNote

public java.lang.String getActionNote()

setActionNote

public void setActionNote(java.lang.String string)

getOutcomeInfoMessage

public java.lang.String getOutcomeInfoMessage()

setOutcomeInfoMessage

public void setOutcomeInfoMessage(java.lang.String pOutcomeInfoMessage)

preFireWorkflowOutcome

public void preFireWorkflowOutcome(DynamoHttpServletRequest pRequest,
                                   DynamoHttpServletResponse pResponse)

No-op method meant for subclassing to add user specific functionality before handleFireWorkflowOutcome is called.

postFireWorkflowOutcome

public void postFireWorkflowOutcome(DynamoHttpServletRequest pRequest,
                                    DynamoHttpServletResponse pResponse)

No-op method meant for subclassing to add user specific functionality after handleFireWorkflowOutcome is called.

handleFireWorkflowOutcome

public void handleFireWorkflowOutcome(javax.portlet.PortletRequest pRequest,
                                      javax.portlet.PortletResponse pResponse)
                               throws javax.servlet.ServletException

Handle method to manage portlet requests.

Throws:

javax.servlet.ServletException

handleFireWorkflowOutcome

public void handleFireWorkflowOutcome(DynamoHttpServletRequest pRequest,
                                      DynamoHttpServletResponse pResponse)
                               throws javax.servlet.ServletException

Handle method to fire the specified workflow outcome element. This will send a message which will advance the workflow to the next task.

Throws:

javax.servlet.ServletException

isCurrentTransactionRolledBack

protected boolean isCurrentTransactionRolledBack(javax.transaction.TransactionManager pTransactionManager)
                                          throws javax.transaction.SystemException

Returns true if the current transaction is marked for rollback.

Throws:

javax.transaction.SystemException