atg.markers.bp
Class BusinessProcessServices

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.markers.bp.BusinessProcessServices

All Implemented Interfaces:

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

public class BusinessProcessServices
extends GenericService
implements BusinessProcessConstants

This class provides the public API for maintaining business process markers with Web services.

See Also:

BusinessProcessManager

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected BusinessProcessManager	mBusinessProcessManager

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

BusinessProcessServices()

Method Summary

boolean	addBusinessProcessStage(java.lang.String pBusinessProcessName, java.lang.String pBusinessProcessStage) Adds a business process marker to the item defined by the business process configuration.
void	doStartService() Verifies the business process manager property is configured.
BusinessProcessManager	getBusinessProcessManager()
boolean	hasBusinessProcessStage(java.lang.String pBusinessProcessName, java.lang.String pBusinessProcessStage) Use this method to test for a business process marker.
boolean	matchMostRecentBusinessProcessStage(java.lang.String pBusinessProcessName, java.lang.String pBusinessProcessStage) Use this method to match the most recent marker for a business process.
int	removeBusinessProcessStage(java.lang.String pBusinessProcessName, java.lang.String pBusinessProcessStage) Use this method to remove business process markers.
void	setBusinessProcessManager(BusinessProcessManager pBusinessProcessManager) Sets the Business Process Manager used for all business process functions.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, 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, 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

mBusinessProcessManager

protected BusinessProcessManager mBusinessProcessManager

Constructor Detail

BusinessProcessServices

public BusinessProcessServices()

Method Detail

getBusinessProcessManager

public BusinessProcessManager getBusinessProcessManager()

setBusinessProcessManager

public void setBusinessProcessManager(BusinessProcessManager pBusinessProcessManager)

Sets the Business Process Manager used for all business process functions.

doStartService

public void doStartService()
                    throws ServiceException

Verifies the business process manager property is configured.

Overrides:

doStartService in class GenericService

Throws:

is - throw if the businessProcessManager property is null.

ServiceException - if the Service had a problem starting up

addBusinessProcessStage

public boolean addBusinessProcessStage(java.lang.String pBusinessProcessName,
                                       java.lang.String pBusinessProcessStage)
                                throws BusinessProcessException,
                                       MarkerException

Adds a business process marker to the item defined by the business process configuration.

Returns:

true if the business process marker was successfully added.

Throws:

BusinessProcessException

MarkerException

See Also:

BusinessProcessManager.addBusinessProcessStage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map, java.lang.String)

removeBusinessProcessStage

public int removeBusinessProcessStage(java.lang.String pBusinessProcessName,
                                      java.lang.String pBusinessProcessStage)
                               throws BusinessProcessException,
                                      MarkerException

Use this method to remove business process markers.

Returns:

the number of business process markers removed.

Throws:

BusinessProcessException

MarkerException

See Also:

BusinessProcessManager.removeBusinessProcessStage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

hasBusinessProcessStage

public boolean hasBusinessProcessStage(java.lang.String pBusinessProcessName,
                                       java.lang.String pBusinessProcessStage)
                                throws BusinessProcessException,
                                       MarkerException

Use this method to test for a business process marker. The test will be successful if a marker is found with property values that match the parameter values.

Returns:

true if a matching business process marker was found.

Throws:

BusinessProcessException

MarkerException

See Also:

BusinessProcessManager.hasBusinessProcessStage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

matchMostRecentBusinessProcessStage

public boolean matchMostRecentBusinessProcessStage(java.lang.String pBusinessProcessName,
                                                   java.lang.String pBusinessProcessStage)
                                            throws BusinessProcessException,
                                                   MarkerException

Use this method to match the most recent marker for a business process. The match will be successful if the most recent marker's property values match the parameter values provided.

Returns:

true if a matching business process marker was found.

Throws:

BusinessProcessException

MarkerException

See Also:

BusinessProcessManager.matchMostRecentBusinessProcessStage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)