atg.markers.bp.droplet
Class BusinessProcessDroplet

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.nucleus.TimedOperationService
              atg.nucleus.servlet.ServletService
                  atg.nucleus.servlet.HttpServletService
                      atg.servlet.DynamoServlet
                          atg.markers.droplet.MarkerDroplet
                              atg.markers.bp.droplet.BusinessProcessDroplet

All Implemented Interfaces:

BusinessProcessConstants, MarkerConstants, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

Direct Known Subclasses:

AddBusinessProcessStage, HasBusinessProcessStage, MostRecentBusinessProcessStage, RemoveBusinessProcessStage

public abstract class BusinessProcessDroplet
extends MarkerDroplet
implements BusinessProcessConstants

This is the base class for a business process droplet.

It provides methods to access the business process parameter values, and overrides validateInput to ensure the required business process params are provided.

property defintions

businessProcessManager

(required) The BusinessProcessManager instance used for all business process api calls.

defaultBusinessProcessName

(optional) the name of the business process. This value is used when the businessProcessName input parameter is not provided.

Field Summary

static ParameterName	BPNAME_PARAM the parameter name for the business process name parameter
static ParameterName	BPSTAGE_PARAM the parameter name for the business process stage parameter
static java.lang.String	CLASS_VERSION Class version string
protected BusinessProcessManager	mBusinessProcessManager the parameter name for the data parameter
protected java.lang.String	mDefaultBusinessProcessName

Fields inherited from class atg.markers.droplet.MarkerDroplet

DATA_PARAM, DUPLICATION_MODE_PARAM, EMPTY_OPARAM, ERROR_MSG_PARAM, ERROR_OPARAM, FALSE_OPARAM, ITEM_ID_PARAM, ITEM_PARAM, KEY_PARAM, MARKED_ITEM_TYPE_PARAM, MARKER_COUNT, MARKER_ELEMENT, MARKER_EXTPROPS_PARAM, MARKER_ITEM_TYPE_PARAM, MARKER_MANAGER_PARAM, MARKER_PROPERTY_NAME_PARAM, MARKERS_ELEMENT, mRepositoryMarkerManager, mTransactionManager, OUTPUT_OPARAM, TRUE_OPARAM, VALUE_PARAM

Fields inherited from class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.markers.bp.BusinessProcessConstants

BUSINESS_PROCESS_RESOURCE_NAME, sBusinessProcessResourceBundle

Fields inherited from interface atg.markers.MarkerConstants

ALLOW_DUPLICATES, ANY_VALUE, DEFAULT_MARKER_ID_PROPERTY_NAME, DEFAULT_MARKER_ITEM_TYPE, DEFAULT_MARKER_PROPERTY_NAME, DEFAULT_MARKER_SORT_PROPERTY_NAME, MARKER_CREATIONDATE_PROPERTY_NAME, MARKER_DATA_PROPERTY_NAME, MARKER_DUPLICATIONMODE_PROPERTY_NAME, MARKER_KEY_PROPERTY_NAME, MARKER_OWNER_PROPERTY_NAME, MARKER_RESOURCE_NAME, MARKER_VALUE_PROPERTY_NAME, NO_DUPLICATES, PARAM_DATA, PARAM_DUPMODE, PARAM_EXTENDED_PROPERTIES, PARAM_ITEM, PARAM_ITEM_ID, PARAM_KEY, PARAM_MARKED_ITEM_TYPE, PARAM_MARKER_ITEM_TYPE, PARAM_MARKER_MANAGER, PARAM_MARKER_PROPERTY_NAME, PARAM_VALUE, REPLACE_DUPLICATES, sResourceBundle

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

BusinessProcessDroplet()

Method Summary

BusinessProcessManager	getBusinessProcessManager() Returns the Business Process Manager used for all business process api calls.
protected java.lang.String	getBusinessProcessName(DynamoHttpServletRequest req) Returns the business process name parameter value from the request.
protected java.lang.String	getBusinessProcessStage(DynamoHttpServletRequest req) Returns the business process stage parameter value from the request
java.lang.String	getDefaultBusinessProcessName() Returns the default business process name for the droplet.
void	setBusinessProcessManager(BusinessProcessManager pBusinessProcessManager) Sets the Business Process Manager used for all business process api calls.
void	setDefaultBusinessProcessName(java.lang.String pDefaultBusinessProcessName) Sets the default business process name for the droplet.
protected void	validateInput(DynamoHttpServletRequest req, DynamoHttpServletResponse res) Validates the input parameters. - verifies that there's a business process name - verifies that there's a business process stage

Methods inherited from class atg.markers.droplet.MarkerDroplet

doService, getANY_VALUE, getData, getDefaultDuplicationMode, getDefaultMarkedItemType, getDefaultMarkerItemType, getDefaultMarkerPropertyName, getDuplicationMode, getExtendedProperties, getItem, getItemId, getKey, getMarkedItemType, getMarkerItemType, getMarkerManager, getMarkerPropertyName, getRepositoryMarkerManager, getTransactionManager, getValue, service, setDefaultDuplicationMode, setDefaultMarkedItemType, setDefaultMarkerItemType, setDefaultMarkerPropertyName, setRepositoryMarkerManager, setTransactionManager

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, init, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

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

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

BPNAME_PARAM

public static final ParameterName BPNAME_PARAM

the parameter name for the business process name parameter

BPSTAGE_PARAM

public static final ParameterName BPSTAGE_PARAM

the parameter name for the business process stage parameter

mBusinessProcessManager

protected BusinessProcessManager mBusinessProcessManager

the parameter name for the data parameter

mDefaultBusinessProcessName

protected java.lang.String mDefaultBusinessProcessName

Constructor Detail

BusinessProcessDroplet

public BusinessProcessDroplet()

Method Detail

setBusinessProcessManager

public void setBusinessProcessManager(BusinessProcessManager pBusinessProcessManager)

Sets the Business Process Manager used for all business process api calls.

getBusinessProcessManager

public BusinessProcessManager getBusinessProcessManager()

Returns the Business Process Manager used for all business process api calls.

setDefaultBusinessProcessName

public void setDefaultBusinessProcessName(java.lang.String pDefaultBusinessProcessName)

Sets the default business process name for the droplet. This value is used when a business process name is not provided as an input parameter.

getDefaultBusinessProcessName

public java.lang.String getDefaultBusinessProcessName()

Returns the default business process name for the droplet. This value is used when a business process name is not provided as an input parameter.

getBusinessProcessName

protected java.lang.String getBusinessProcessName(DynamoHttpServletRequest req)
                                           throws MarkerException

Returns the business process name parameter value from the request. If the input parameter is not provided, the defaultBusinessProcessName is returned.

Returns:

the business process name

Throws:

MarkerException

getBusinessProcessStage

protected java.lang.String getBusinessProcessStage(DynamoHttpServletRequest req)
                                            throws MarkerException

Returns the business process stage parameter value from the request

Returns:

the business process stage

Throws:

MarkerException

validateInput

protected void validateInput(DynamoHttpServletRequest req,
                             DynamoHttpServletResponse res)
                      throws MarkerException

Validates the input parameters.
- verifies that there's a business process name
- verifies that there's a business process stage

Overrides:

validateInput in class MarkerDroplet

Throws:

on - validation error

MarkerException