com.aspc.workflow

Class DBActionCommand

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBAction

com.aspc.workflow.DBActionCommand

All Implemented Interfaces:

SecondaryCacheGroup

public class DBActionCommand
extends DBAction

Runs a OSQL command such as Insert, Delete, Update.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

4 August, 2004

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Runs a OSQL command such as Insert, Delete, Update.
static java.lang.String	DBCLASS_NAME Runs a OSQL command such as Insert, Delete, Update.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBActionCommand(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
java.lang.String	getCommand(java.lang.String... args)
java.lang.String	parseCommand(java.lang.String cmd, DBObject baseObj) Parses the command Path strings delimited by $ signs. The string path can begin with globals, base or sender.
void	process(MutableDataSource mds, DBObject base) Performs the operations on the data source for this event
DBActionCommand	setCommand(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.workflow.DBAction

findKey, findType, getCondition, getDisplaySummary, getEvent, getID, getSeq, getSummary, getType, isApplicable, isInactive, makeQuery, setCondition, setEvent, setID, setInactive, setSeq, setSummary, setType

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Runs a OSQL command such as Insert, Delete, Update.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Runs a OSQL command such as Insert, Delete, Update.

Constructor Detail

DBActionCommand

public DBActionCommand(DBClass def,
                       DataSource dataSource)
                throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getCommand

@CheckReturnValue
 @Nonnull
public java.lang.String getCommand(java.lang.String... args)

setCommand

@Nonnull
public DBActionCommand setCommand(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

process

public void process(MutableDataSource mds,
                    DBObject base)
             throws java.lang.Exception

Performs the operations on the data source for this event

Specified by:

process in class DBAction

Parameters:

mds - - MutableDataSource that action should be applied to

base - - Base Object that the event was raised for

Throws:

java.lang.Exception - Exception

parseCommand

public java.lang.String parseCommand(@Nonnull
                                     java.lang.String cmd,
                                     @Nullable
                                     DBObject baseObj)
                              throws java.lang.Exception

Parses the command Path strings delimited by $ signs.
The string path can begin with globals, base or sender. followed by the
appropriate field.
By adding text after a comma at the end of the path, any missing data will
will be substituted by the supplied text.
Format: $path,text if missing$

Parameters:

cmd -

baseObj -

Returns:

Throws:

java.lang.Exception

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem