|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.markers.ValidateMarkerByPossibleValue atg.markers.ConfigurableMarkerValidator atg.markers.bp.BusinessProcessConfiguration
public abstract class BusinessProcessConfiguration
Business Process configuration class.
This is the base class for a business process configuration. It contains the properties that are common to all types of configurations.
BusinessProcessManager.deleteBusinessProcessMarkers
API.
doStartService
method adds
the configuration object to the MarkerValidatorContainer. Typically, the
marker validator container is the same as the marker manager that will
handle markers for the business process.This class is abstract to prevent instantiation of components based on this class.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected java.lang.String |
mBusinessProcessName
|
protected java.lang.String |
mDuplicationMode
|
protected boolean |
mEnabled
|
protected boolean |
mGenerateEvents
|
protected java.lang.String |
mMarkedItemType
|
protected java.lang.String |
mMarkerItemType
|
protected java.lang.String |
mMarkerPropertyName
|
protected MarkerValidatorContainer |
mMarkerValidatorContainer
|
protected java.lang.String[] |
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.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 | |
---|---|
BusinessProcessConfiguration()
|
Method Summary | |
---|---|
void |
doStartService()
Validates the configuration by calling validateConfiguration and adds this object to the MarkerValidatorContainer. |
java.lang.String |
getBusinessProcessName()
Returns the name of the business process |
java.lang.String |
getDuplicationMode()
|
java.lang.String |
getMarkedItemType()
|
java.lang.String |
getMarkerItemType()
|
java.lang.String |
getMarkerPropertyName()
|
MarkerValidatorContainer |
getMarkerValidatorContainer()
Returns the MarkerValidatorContainer associated with this Business Process. |
java.lang.String[] |
getPossibleValues()
Gets the array of possible marker values. |
java.lang.String[] |
getStageNames()
Gets the array of possible business process stage names. |
boolean |
isEnabled()
Boolean flag for optionally disabling a business process. |
boolean |
isGenerateEvents()
Boolean flag for optionally generating JMS events for this business process. |
boolean |
isNullValueValid()
Override to make null an invalid stage for a bp marker. |
void |
setBusinessProcessName(java.lang.String pBusinessProcessName)
Sets the name of the business process |
void |
setDuplicationMode(java.lang.String pDuplicationMode)
Sets the duplication mode used for adding new business process markers. |
void |
setEnabled(boolean pEnabled)
Sets the boolean flag for optionally disabling a business process |
void |
setGenerateEvents(boolean pGenerateEvents)
Sets the boolean flag for optionally generating JMS events for this business process |
void |
setMarkedItemType(java.lang.String pMarkedItemType)
Sets the marked item type. |
void |
setMarkerItemType(java.lang.String pMarkerItemType)
Sets the marker item type used when creating new business process markers. |
void |
setMarkerPropertyName(java.lang.String pMarkerPropertyName)
Sets the marker property name where the business process markers are maintained on the containing object. |
void |
setMarkerValidatorContainer(MarkerValidatorContainer pMarkerValidatorContainer)
Sets the MarkerValidatorContainer associated with this Business Process. |
void |
setStageNames(java.lang.String[] pStageNames)
Sets the array of possible business process stage names. |
void |
validateConfiguration()
Validates the property settings for the configuration component |
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.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 |
---|
public static java.lang.String CLASS_VERSION
protected java.lang.String mBusinessProcessName
protected java.lang.String[] mStageNames
protected java.lang.String mDuplicationMode
protected java.lang.String mMarkerPropertyName
protected java.lang.String mMarkedItemType
protected java.lang.String mMarkerItemType
protected boolean mEnabled
protected boolean mGenerateEvents
protected MarkerValidatorContainer mMarkerValidatorContainer
Constructor Detail |
---|
public BusinessProcessConfiguration()
Method Detail |
---|
public boolean isNullValueValid()
isNullValueValid
in class ValidateMarkerByPossibleValue
public void setBusinessProcessName(java.lang.String pBusinessProcessName)
public java.lang.String getBusinessProcessName()
public java.lang.String[] getStageNames()
public void setStageNames(java.lang.String[] pStageNames)
public java.lang.String[] getPossibleValues()
This override returns the values from the stageNames
property
getPossibleValues
in class ConfigurableMarkerValidator
public void setDuplicationMode(java.lang.String pDuplicationMode)
public java.lang.String getDuplicationMode()
public void setMarkerPropertyName(java.lang.String pMarkerPropertyName)
public java.lang.String getMarkerPropertyName()
public void setMarkedItemType(java.lang.String pMarkedItemType)
public java.lang.String getMarkedItemType()
public void setMarkerItemType(java.lang.String pMarkerItemType)
public java.lang.String getMarkerItemType()
public void setEnabled(boolean pEnabled)
public boolean isEnabled()
When a business process is disabled, stages cannot be added or removed. Also, conditional testing for the existence of stages will always return false or null.
public void setGenerateEvents(boolean pGenerateEvents)
public boolean isGenerateEvents()
public void setMarkerValidatorContainer(MarkerValidatorContainer pMarkerValidatorContainer)
public MarkerValidatorContainer getMarkerValidatorContainer()
MarkerValidatorContainer
associated with this Business Processpublic void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic void validateConfiguration() throws BusinessProcessException
BusinessProcessException
- for properties that aren't properly
configured.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |