atg.epub.servlet
Class TaskActionFormHandler

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

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 TaskActionFormHandler
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	ASSIGN_RELEASE
static java.lang.String	ASSIGN_UNASSIGNED
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

TaskActionFormHandler()

Method Summary

java.lang.String	getAssignee() Returns the assignee for the assignTask handler.
java.lang.String	getTaskElementId()
void	handleAssignTask(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Handle method to claim a workflow task for the current user.
void	handleAssignTask(javax.portlet.PortletRequest pRequest, javax.portlet.PortletResponse pResponse)
void	handleClaimTask(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Handle method to claim a workflow task for the current user.
void	handleClaimTask(javax.portlet.PortletRequest pRequest, javax.portlet.PortletResponse pResponse)
void	handleReleaseTask(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Handle method to claim a workflow task for the current user.
void	handleReleaseTask(javax.portlet.PortletRequest pRequest, javax.portlet.PortletResponse pResponse)
void	postAssignTask(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) No-op method meant for subclassing to add user specific functionality after handleAssignTask is called.
void	postClaimTask(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) No-op method meant for subclassing to add user specific functionality after handleClaimTask is called.
void	postReleaseTask(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) No-op method meant for subclassing to add user specific functionality after handleReleaseTask is called.
void	preAssignTask(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) No-op method meant for subclassing to add user specific functionality before handleAssignTask is called.
void	preClaimTask(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) No-op method meant for subclassing to add user specific functionality before handleClaimTask is called.
void	preReleaseTask(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) No-op method meant for subclassing to add user specific functionality before handleReleaseTask is called.
void	setAssignee(java.lang.String pAssignee) The assignee which takes the form of user.primaryKey:user.userDirectory.userDirectoryName
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

ASSIGN_RELEASE

public static final java.lang.String ASSIGN_RELEASE

See Also:

Constant Field Values

ASSIGN_UNASSIGNED

public static final java.lang.String ASSIGN_UNASSIGNED

See Also:

Constant Field Values

Constructor Detail

TaskActionFormHandler

public TaskActionFormHandler()

Method Detail

getTaskElementId

public java.lang.String getTaskElementId()

setTaskElementId

public void setTaskElementId(java.lang.String pTaskElementId)

getAssignee

public java.lang.String getAssignee()

Returns the assignee for the assignTask handler.

setAssignee

public void setAssignee(java.lang.String pAssignee)

The assignee which takes the form of user.primaryKey:user.userDirectory.userDirectoryName

preClaimTask

public void preClaimTask(DynamoHttpServletRequest pRequest,
                         DynamoHttpServletResponse pResponse)

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

postClaimTask

public void postClaimTask(DynamoHttpServletRequest pRequest,
                          DynamoHttpServletResponse pResponse)

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

handleClaimTask

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

Throws:

javax.servlet.ServletException

handleClaimTask

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

Handle method to claim a workflow task for the current user.

Throws:

javax.servlet.ServletException

preAssignTask

public void preAssignTask(DynamoHttpServletRequest pRequest,
                          DynamoHttpServletResponse pResponse)

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

postAssignTask

public void postAssignTask(DynamoHttpServletRequest pRequest,
                           DynamoHttpServletResponse pResponse)

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

handleAssignTask

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

Throws:

javax.servlet.ServletException

handleAssignTask

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

Handle method to claim a workflow task for the current user. Passing the string "RELEASE" as the assignee will release the assignment. Calls handleReleaseTask internally. Passing the string "UNASSIGNED" will ignore the request and return.

Throws:

javax.servlet.ServletException

preReleaseTask

public void preReleaseTask(DynamoHttpServletRequest pRequest,
                           DynamoHttpServletResponse pResponse)

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

postReleaseTask

public void postReleaseTask(DynamoHttpServletRequest pRequest,
                            DynamoHttpServletResponse pResponse)

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

handleReleaseTask

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

Throws:

javax.servlet.ServletException

handleReleaseTask

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

Handle method to claim a workflow task for the current user.

Throws:

javax.servlet.ServletException