atg.markers.bp
Class ItemBasedProcessConfiguration

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.markers.ValidateMarkerByPossibleValue
              atg.markers.ConfigurableMarkerValidator
                  atg.markers.bp.BusinessProcessConfiguration
                      atg.markers.bp.ItemBasedProcessConfiguration

All Implemented Interfaces:

BusinessProcessConstants, MarkerConstants, MarkerValidator, 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

Direct Known Subclasses:

ProfileBasedProcessConfiguration

public abstract class ItemBasedProcessConfiguration
extends BusinessProcessConfiguration

This class can be extended to create a business process configuration that is based on a repository item.

The following are the properties of an item based business process configuration.

repositoryMarkerManager

the repository marker manager to use when marking items for this business process.

findItem should be implemented to return the appropriate repository item for the business process.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected RepositoryMarkerManager	mRepositoryMarkerManager

Fields inherited from class atg.markers.bp.BusinessProcessConfiguration

mBusinessProcessName, mDuplicationMode, mEnabled, mGenerateEvents, mMarkedItemType, mMarkerItemType, mMarkerPropertyName, mMarkerValidatorContainer, mStageNames

Fields inherited from class atg.markers.ValidateMarkerByPossibleValue

mAcceptAllValues, mNullValueValid

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

ItemBasedProcessConfiguration()

Method Summary

abstract RepositoryItem	findItem() Finds the repository item to be used for the business process.
java.lang.String	getMarkedItemType() This extension will return the default marked item type of the configured RepositoryMarkerManager if the property is not already configured.
MarkerValidatorContainer	getMarkerValidatorContainer() Gets the MarkerValidator that contains this marker validator.
RepositoryMarkerManager	getRepositoryMarkerManager() Returns the RepositoryMarkerManager for the business process
void	setRepositoryMarkerManager(RepositoryMarkerManager pRepositoryMarkerManager) Sets the RepositoryMarkerManager to use for this business process
void	validateConfiguration() Validates the property settings for the configuration component

Methods inherited from class atg.markers.bp.BusinessProcessConfiguration

doStartService, getBusinessProcessName, getDuplicationMode, getMarkerItemType, getMarkerPropertyName, getPossibleValues, getStageNames, isEnabled, isGenerateEvents, isNullValueValid, setBusinessProcessName, setDuplicationMode, setEnabled, setGenerateEvents, setMarkedItemType, setMarkerItemType, setMarkerPropertyName, setMarkerValidatorContainer, setStageNames

Methods inherited from class atg.markers.ConfigurableMarkerValidator

getValidValuesForKey, setPossibleValues

Methods inherited from class atg.markers.ValidateMarkerByPossibleValue

isAcceptAllValues, isValidMarker, isValidValueForKey, setAcceptAllValues, setNullValueValid

Methods inherited from class atg.nucleus.GenericService

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

mRepositoryMarkerManager

protected RepositoryMarkerManager mRepositoryMarkerManager

Constructor Detail

ItemBasedProcessConfiguration

public ItemBasedProcessConfiguration()

Method Detail

setRepositoryMarkerManager

public void setRepositoryMarkerManager(RepositoryMarkerManager pRepositoryMarkerManager)

Sets the RepositoryMarkerManager to use for this business process

getRepositoryMarkerManager

public RepositoryMarkerManager getRepositoryMarkerManager()

Returns the RepositoryMarkerManager for the business process

getMarkedItemType

public java.lang.String getMarkedItemType()

This extension will return the default marked item type of the configured RepositoryMarkerManager if the property is not already configured.

Overrides:

getMarkedItemType in class BusinessProcessConfiguration

Returns:

the marked item type.

findItem

public abstract RepositoryItem findItem()

Finds the repository item to be used for the business process. This method is called by the BusinessProcessManager when item is not provided through its API.

Returns:

the repository item to be marked

getMarkerValidatorContainer

public MarkerValidatorContainer getMarkerValidatorContainer()

Gets the MarkerValidator that contains this marker validator.

Overrides:

getMarkerValidatorContainer in class BusinessProcessConfiguration

Returns:

the MarkerValidatorContainer that contains this marker validator.

validateConfiguration

public void validateConfiguration()
                           throws BusinessProcessException

Validates the property settings for the configuration component

Overrides:

validateConfiguration in class BusinessProcessConfiguration

Throws:

BusinessProcessException - for properties that aren't properly configured.