DBJob (stSoftware API)

java.lang.Object
- com.aspc.DBObj.DBObject
- - com.aspc.job.DBJob

All Implemented Interfaces:

SecondaryCacheGroup
```
public class DBJob
extends DBObject
```
A job which will be processed in the background.

Notes

Problems:-
1. Worker's clock can be out of sync. Workers can be on different machines. This causes an issue that the clocks on these machines may be out of sync. We will attempt to adjust for this problem.
2. Slow or missing JMS messages
3. Unreliable S/FTP servers
4. Race condition bidding for a job
data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED
Since:

4 December 2003

Author:

Nigel Leck

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` A job which will be processed in the background.
`static java.lang.String`	`DBCLASS_NAME` A job which will be processed in the background.

Fields inherited from class com.aspc.DBObj.DBObject
ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors
Constructor and Description

DBJob(DBClass def, DataSource dataSource)
Std.

Constructors
Constructor and Description
`DBJob(DBClass def, DataSource dataSource)` Std.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` cancel the job
`boolean`	`canChange(java.lang.String... args)`
`static DBJob`	`create(MutableDataSource mds)` Make a new instance of this class.
`boolean`	`disableUserCancellation(java.lang.String... args)`
`java.lang.String`	`displayName()` The human readable job name
`java.lang.String`	`encodedResults(java.lang.String encoding)` The compressed and encoded version of the results
`protected void`	`eventDataLoaded()` When the underlying DBData is changed/ loaded.
`protected void`	`eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params)` check the status.
`protected void`	`extAutoEnterCreate()` Additional functionality when an object is created.
`protected void`	`extFixUp()` The extended fix up routine
`protected java.lang.Object`	`extGetDerivedValue(DBField field, FldParams params)` Calculate the derived value for this field.
`protected void`	`extPostDeleteRecord(long transNr)` run the on complete commands
`protected void`	`extPostSaveRecord(long transNr)` run the on complete commands
`protected void`	`extPreDeleteRecord()` Additional functionality WHILE saving this record to the database.
`protected void`	`extPreSaveRecord()` Additional functionality WHILE saving this record to the database.
`protected void`	`extPreValidate()` OVERRIDE To add functionality to before validation is called.
`protected void`	`extPreValidateDelete()` OVERRIDE To add functionality to before validation is called.
`protected void`	`extSetValue(DBField field, java.lang.Object currentValue, FldParams params)` 1) Control the setting of status 2) Don't allow the user to set maxHeartBeatDurationMS we will calculate this.
`protected ValidationError`	`extValidateField(DBField field, ValidationList list)` Additional validation for a particular field.
`protected void`	`extValidateRecord(ValidationList list)` Performs additional validations on this record.
`DBFile`	`findCommandUserFile(java.lang.String... args)` The file that holds the raw commands of the users request.
`DBFileStore`	`findDataStore(java.lang.String... args)` The location of the job data.
`DBJobManagerSession`	`findDroidSession(java.lang.String... args)` The session id of the droid that bid and won the job.
`static DBJob`	`findKey(DataSource ds, int key)` Find the target for this class by the primary key
`DBQueue`	`findQueue(java.lang.String... args)` The queue for this job.
`DBJobManagerSession`	`findRunnerSession(java.lang.String... args)` The Job Manager that is running/ran this job.
`DBJobStatistic`	`findStatistic(java.lang.String... args)` the statistic record.
`DBJobManagerSession`	`findTargetSession(java.lang.String... args)` The target job manager for this job.
`Person`	`findTerminatedBy(java.lang.String... args)` The ID of the person that cancelled/killed this JOB.
`Login`	`findUserId(java.lang.String... args)` Who the job is for.
`boolean`	`forceToDB(java.lang.String message)` Repeatedly try to write this job to the database.
`java.lang.String`	`getChecksumCommandFile(java.lang.String... args)`
`java.lang.String`	`getChecksumResultFile(java.lang.String... args)`
`java.lang.String`	`getCode(java.lang.String... args)`
`java.lang.String`	`getCommands(java.lang.String... args)`
`DBFile`	`getCommandUserFile(java.lang.String... args)`
`int`	`getConnectionVersion(java.lang.String... args)`
`int`	`getCurrRetryCount(java.lang.String... args)`
`DBFileStore`	`getDataStore(java.lang.String... args)`
`java.lang.String`	`getDisplayName(java.lang.String... args)`
`DBJobManagerSession`	`getDroidSession(java.lang.String... args)`
`java.lang.String`	`getErrorTx(java.lang.String... args)`
`Connection`	`getExcuteConnection()` the connection
`java.util.Date`	`getFinishedTS(java.lang.String... args)`
`java.util.Date`	`getHeartBeatTS(java.lang.String... args)`
`int`	`getID(java.lang.String... args)`
`java.lang.String`	`getJobID()` An human readable version of the job's global id.
`java.lang.String`	`getMaxHeartBeatDuration(java.lang.String... args)`
`long`	`getMaxHeartBeatDurationMS(java.lang.String... args)`
`java.lang.String`	`getMaxRunTime(java.lang.String... args)`
`long`	`getMaxRunTimeMS(java.lang.String... args)`
`static long`	`getMinCommandFileSize()` The min size of the commands before we would create a file instead of a simple text file
`java.lang.String`	`getMinHeartBeatDuration(java.lang.String... args)`
`long`	`getMinHeartBeatDurationMS(java.lang.String... args)`
`static long`	`getMinResultFileSize()` The min size of the commands before we would create a file instead of a simple text file
`java.lang.String`	`getOnCompleteCommands(java.lang.String... args)`
`java.lang.String`	`getOnErrorCommands(java.lang.String... args)`
`java.lang.String`	`getOnRetryCommands(java.lang.String... args)`
`java.lang.String`	`getOnStartCommands(java.lang.String... args)`
`java.lang.String`	`getOnWarningCommands(java.lang.String... args)`
`java.lang.String`	`getProcessMsg(java.lang.String... args)`
`java.util.Date`	`getProcessTimeOnRetry(java.lang.String... args)`
`java.lang.String`	`getProcessTimeTakenOnRetry(java.lang.String... args)`
`java.util.Date`	`getProgressTS(java.lang.String... args)`
`DBQueue`	`getQueue(java.lang.String... args)`
`java.util.Date`	`getQueuedTS(java.lang.String... args)`
`int`	`getQueuePriority(java.lang.String... args)`
`java.lang.String`	`getRawCommands(java.lang.String... args)`
`java.lang.String`	`getRawProgressMsg(java.lang.String... args)`
`java.io.File`	`getRawResultFile()`
`java.lang.String`	`getRawResults(java.lang.String... args)`
`java.lang.String`	`getResults(java.lang.String... args)`
`long`	`getResultSize(java.lang.String... args)`
`int`	`getRetryCount(java.lang.String... args)`
`DBJobManagerSession`	`getRunnerSession(java.lang.String... args)`
`java.util.Date`	`getStartedTS(java.lang.String... args)`
`DBJobStatistic`	`getStatistic(java.lang.String... args)`
`java.lang.String`	`getStatus()` A short hand method to get the status of the job.
`java.lang.String`	`getTargetName(java.lang.String... args)`
`DBJobManagerSession`	`getTargetSession(java.lang.String... args)`
`Person`	`getTerminatedBy(java.lang.String... args)`
`java.lang.String`	`getTimeZone(java.lang.String... args)`
`java.lang.String`	`getTotalTime(java.lang.String... args)`
`long`	`getTotalTimeMS(java.lang.String... args)`
`Login`	`getUserId(java.lang.String... args)`
`java.util.List<java.lang.String>`	`getWaitForJob(java.lang.String... args)`
`java.lang.String`	`getWarningTx(java.lang.String... args)`
`boolean`	`isFinalFg(java.lang.String... args)`
`boolean`	`isPause(java.lang.String... args)`
`boolean`	`isWaitCheckSuccessfulForJobs(java.lang.String... args)`
`static java.lang.String`	`makeID(GlobalId jobId)` make the display name
`static GlobalKey`	`makeJobKey(java.lang.String jobId)` Makes a global key from an ASCII key
`static DBQuery<DBJob>`	`makeQuery(DataSource ds)` Make a new QUERY for this class.
`static SearchPlan`	`makeSearchPlan(DBQuery<DBObject> query)` Allows for specific attributes to be set for the queries
`static void`	`onErrorJob(DBJob jobToError, java.lang.String errorMessage)` run the "ON ERROR" script
`static void`	`onWarnJob(DBJob jobToWarn)` run the "ON WARNING" script
`void`	`releaseMemory()` Release all the memory held by this JOB
`DBJob`	`setChecksumCommandFile(java.lang.String value, java.lang.String... args)`
`DBJob`	`setChecksumResultFile(java.lang.String value, java.lang.String... args)`
`DBJob`	`setCode(java.lang.String value, java.lang.String... args)`
`void`	`setCommand(java.lang.String command)` The commands to be processed.
`DBJob`	`setCommandUserFile(com.aspc.dal.file.DBFile value, java.lang.String... args)`
`DBJob`	`setConnectionVersion(int value, java.lang.String... args)`
`DBJob`	`setCurrRetryCount(int value, java.lang.String... args)`
`DBJob`	`setDataStore(com.aspc.dal.file.DBFileStore value, java.lang.String... args)`
`DBJob`	`setDisableUserCancellation(boolean value, java.lang.String... args)`
`DBJob`	`setDroidSession(com.aspc.dal.job.DBJobManagerSession value, java.lang.String... args)`
`DBJob`	`setErrorTx(java.lang.String value, java.lang.String... args)`
`void`	`setExcuteConnection(Connection connection)` set the connection
`DBJob`	`setFinalFg(boolean value, java.lang.String... args)`
`DBJob`	`setFinishedTS(java.util.Date value, java.lang.String... args)`
`DBJob`	`setHeartBeatTS(java.util.Date value, java.lang.String... args)`
`DBJob`	`setID(int value, java.lang.String... args)`
`DBJob`	`setMaxHeartBeatDuration(java.lang.String value, java.lang.String... args)`
`DBJob`	`setMaxHeartBeatDurationMS(long value, java.lang.String... args)`
`DBJob`	`setMaxRunTime(java.lang.String value, java.lang.String... args)`
`static void`	`setMinCommandFileSize(long bytes)` The min size of the commands before we would create a file instead of a simple text file
`DBJob`	`setMinHeartBeatDuration(java.lang.String value, java.lang.String... args)`
`static void`	`setMinResultFileSize(long bytes)` The min size of the commands before we would create a file instead of a simple text file
`DBJob`	`setOnCompleteCommands(java.lang.String value, java.lang.String... args)`
`DBJob`	`setOnErrorCommands(java.lang.String value, java.lang.String... args)`
`DBJob`	`setOnRetryCommands(java.lang.String value, java.lang.String... args)`
`DBJob`	`setOnStartCommands(java.lang.String value, java.lang.String... args)`
`DBJob`	`setOnWarningCommands(java.lang.String value, java.lang.String... args)`
`DBJob`	`setPause(boolean value, java.lang.String... args)`
`DBJob`	`setProcessTimeOnRetry(java.util.Date value, java.lang.String... args)`
`DBJob`	`setProcessTimeTakenOnRetry(java.lang.String value, java.lang.String... args)`
`DBJob`	`setProgressTS(java.util.Date value, java.lang.String... args)`
`DBJob`	`setQueue(com.aspc.dal.job.DBQueue value, java.lang.String... args)`
`DBJob`	`setQueuedTS(java.util.Date value, java.lang.String... args)`
`DBJob`	`setQueuePriority(int value, java.lang.String... args)`
`DBJob`	`setRawCommands(java.lang.String value, java.lang.String... args)`
`DBJob`	`setRawProgressMsg(java.lang.String value, java.lang.String... args)`
`DBJob`	`setRawResults(java.lang.String value, java.lang.String... args)`
`void`	`setResult(java.lang.String results)` The results
`DBJob`	`setResultSize(long value, java.lang.String... args)`
`DBJob`	`setRetryCount(int value, java.lang.String... args)`
`DBJob`	`setRunnerSession(com.aspc.dal.job.DBJobManagerSession value, java.lang.String... args)`
`DBJob`	`setStartedTS(java.util.Date value, java.lang.String... args)`
`DBJob`	`setStatistic(com.aspc.dal.job.statistic.DBJobStatistic value, java.lang.String... args)`
`DBJob`	`setStatus(com.aspc.dal.job.DBJobStatus value, java.lang.String... args)`
`DBJob`	`setTargetName(java.lang.String value, java.lang.String... args)`
`DBJob`	`setTargetSession(com.aspc.dal.job.DBJobManagerSession value, java.lang.String... args)`
`DBJob`	`setTerminatedBy(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)`
`DBJob`	`setTimeZone(java.lang.String value, java.lang.String... args)`
`DBJob`	`setUserId(com.aspc.dal.dbobj.contact.Login value, java.lang.String... args)`
`DBJob`	`setWaitCheckSuccessfulForJobs(boolean value, java.lang.String... args)`
`DBJob`	`setWaitForJob(java.util.List<java.lang.String> value, java.lang.String... args)`
`DBJob`	`setWarningTx(java.lang.String value, java.lang.String... args)`
`void`	`waitStartToComplete()` wait for the job "on start" script to complete
`java.lang.String`	`waitToComplete(long timeout)` Wait for this job to complete for an amount of time.
`boolean`	`writeToDB(java.lang.String message)` Write the JOB to the database if it isn't new ( EXECUTEd) Database concurrency We expect to get dirty cache exceptions where and we DO NOT retry the statement.

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, displayValue, doSearch, dump, equals, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, 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, 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
```
  A job which will be processed in the background.
  
  See Also:
  
  Constant Field Values
- DBCLASS_GID
```
public static final GlobalId DBCLASS_GID
```
  A job which will be processed in the background.

Constructor Detail
- DBJob
```
public DBJob(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

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public DBJob setID(int value,
                            java.lang.String... args)
                     throws java.lang.Exception

Throws:: java.lang.Exception

canChange

@CheckReturnValue
public boolean canChange(java.lang.String... args)

getChecksumCommandFile

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

setChecksumCommandFile

@Nonnull
public DBJob setChecksumCommandFile(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:: java.lang.Exception

getChecksumResultFile

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

setChecksumResultFile

@Nonnull
public DBJob setChecksumResultFile(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getCode

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

setCode

@Nonnull
public DBJob setCode(java.lang.String value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:: java.lang.Exception

getCommandUserFile

@CheckReturnValue
 @Nullable
public DBFile getCommandUserFile(java.lang.String... args)

findCommandUserFile
```
@CheckReturnValue
 @Nonnull
public final DBFile findCommandUserFile(java.lang.String... args)
                                                             throws NotFoundException
```
The file that holds the raw commands of the users request.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setCommandUserFile

@Nonnull
public DBJob setCommandUserFile(com.aspc.dal.file.DBFile value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getCommands

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

getConnectionVersion

@CheckReturnValue
public int getConnectionVersion(java.lang.String... args)

setConnectionVersion

@Nonnull
public DBJob setConnectionVersion(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

getCurrRetryCount

@CheckReturnValue
public int getCurrRetryCount(java.lang.String... args)

setCurrRetryCount

@Nonnull
public DBJob setCurrRetryCount(int value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

getDataStore

@CheckReturnValue
 @Nullable
public DBFileStore getDataStore(java.lang.String... args)

findDataStore
```
@CheckReturnValue
 @Nonnull
public final DBFileStore findDataStore(java.lang.String... args)
                                                            throws NotFoundException
```
The location of the job data.

--> DBFileStore (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBFileStore

Throws:

NotFoundException - DBFileStore was not found

setDataStore

@Nonnull
public DBJob setDataStore(com.aspc.dal.file.DBFileStore value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

disableUserCancellation

@CheckReturnValue
public boolean disableUserCancellation(java.lang.String... args)

setDisableUserCancellation

@Nonnull
public DBJob setDisableUserCancellation(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:: java.lang.Exception

getDisplayName

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

getDroidSession

@CheckReturnValue
 @Nullable
public DBJobManagerSession getDroidSession(java.lang.String... args)

findDroidSession
```
@CheckReturnValue
 @Nonnull
public final DBJobManagerSession findDroidSession(java.lang.String... args)
                                                                       throws NotFoundException
```
The session id of the droid that bid and won the job.

--> DBJobManagerSession (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBJobManagerSession

Throws:

NotFoundException - DBJobManagerSession was not found

setDroidSession

@Nonnull
public DBJob setDroidSession(com.aspc.dal.job.DBJobManagerSession value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getErrorTx

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

setErrorTx

@Nonnull
public DBJob setErrorTx(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:: java.lang.Exception

isFinalFg

@CheckReturnValue
public boolean isFinalFg(java.lang.String... args)

setFinalFg

@Nonnull
public DBJob setFinalFg(boolean value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:: java.lang.Exception

getFinishedTS

@CheckReturnValue
 @Nullable
public java.util.Date getFinishedTS(java.lang.String... args)

setFinishedTS

@Nonnull
public DBJob setFinishedTS(java.util.Date value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getHeartBeatTS

@CheckReturnValue
 @Nullable
public java.util.Date getHeartBeatTS(java.lang.String... args)

setHeartBeatTS

@Nonnull
public DBJob setHeartBeatTS(java.util.Date value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

getMaxHeartBeatDuration

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

setMaxHeartBeatDuration

@Nonnull
public DBJob setMaxHeartBeatDuration(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:: java.lang.Exception

getMaxHeartBeatDurationMS

@CheckReturnValue
public long getMaxHeartBeatDurationMS(java.lang.String... args)

setMaxHeartBeatDurationMS

@Nonnull
public DBJob setMaxHeartBeatDurationMS(long value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:: java.lang.Exception

getMaxRunTime

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

setMaxRunTime

@Nonnull
public DBJob setMaxRunTime(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getMaxRunTimeMS

@CheckReturnValue
public long getMaxRunTimeMS(java.lang.String... args)

getMinHeartBeatDuration

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

setMinHeartBeatDuration

@Nonnull
public DBJob setMinHeartBeatDuration(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:: java.lang.Exception

getMinHeartBeatDurationMS

@CheckReturnValue
public long getMinHeartBeatDurationMS(java.lang.String... args)

getOnCompleteCommands

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

setOnCompleteCommands

@Nonnull
public DBJob setOnCompleteCommands(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getOnErrorCommands

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

setOnErrorCommands

@Nonnull
public DBJob setOnErrorCommands(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getOnRetryCommands

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

setOnRetryCommands

@Nonnull
public DBJob setOnRetryCommands(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getOnStartCommands

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

setOnStartCommands

@Nonnull
public DBJob setOnStartCommands(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:: java.lang.Exception

getOnWarningCommands

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

setOnWarningCommands

@Nonnull
public DBJob setOnWarningCommands(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:: java.lang.Exception

isPause

@CheckReturnValue
public boolean isPause(java.lang.String... args)

setPause

@Nonnull
public DBJob setPause(boolean value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:: java.lang.Exception

getProcessMsg

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

getProcessTimeOnRetry

@CheckReturnValue
 @Nullable
public java.util.Date getProcessTimeOnRetry(java.lang.String... args)

setProcessTimeOnRetry

@Nonnull
public DBJob setProcessTimeOnRetry(java.util.Date value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:: java.lang.Exception

getProcessTimeTakenOnRetry

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

setProcessTimeTakenOnRetry

@Nonnull
public DBJob setProcessTimeTakenOnRetry(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:: java.lang.Exception

getProgressTS

@CheckReturnValue
 @Nullable
public java.util.Date getProgressTS(java.lang.String... args)

setProgressTS

@Nonnull
public DBJob setProgressTS(java.util.Date value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getQueue

@CheckReturnValue
 @Nullable
public DBQueue getQueue(java.lang.String... args)

findQueue

@CheckReturnValue
 @Nonnull
public final DBQueue findQueue(java.lang.String... args)
                                                    throws NotFoundException

The queue for this job.

--> DBQueue (String, Searchable)

Parameters:: args - the optional arguments
Returns:: DBQueue
Throws:: NotFoundException - DBQueue was not found

setQueue

@Nonnull
public DBJob setQueue(com.aspc.dal.job.DBQueue value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:: java.lang.Exception

getQueuePriority

@CheckReturnValue
public int getQueuePriority(java.lang.String... args)

setQueuePriority

@Nonnull
public DBJob setQueuePriority(int value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

getQueuedTS

@CheckReturnValue
public java.util.Date getQueuedTS(java.lang.String... args)

setQueuedTS

@Nonnull
public DBJob setQueuedTS(java.util.Date value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

getRawCommands

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

setRawCommands

@Nonnull
public DBJob setRawCommands(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:: java.lang.Exception

getRawProgressMsg

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

setRawProgressMsg

@Nonnull
public DBJob setRawProgressMsg(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

getRawResults

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

setRawResults

@Nonnull
public DBJob setRawResults(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getResultSize

@CheckReturnValue
public long getResultSize(java.lang.String... args)

setResultSize

@Nonnull
public DBJob setResultSize(long value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getResults

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

getRetryCount

@CheckReturnValue
public int getRetryCount(java.lang.String... args)

setRetryCount

@Nonnull
public DBJob setRetryCount(int value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getRunnerSession

@CheckReturnValue
 @Nullable
public DBJobManagerSession getRunnerSession(java.lang.String... args)

findRunnerSession
```
@CheckReturnValue
 @Nonnull
public final DBJobManagerSession findRunnerSession(java.lang.String... args)
                                                                        throws NotFoundException
```
The Job Manager that is running/ran this job.

--> DBJobManagerSession (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBJobManagerSession

Throws:

NotFoundException - DBJobManagerSession was not found

setRunnerSession

@Nonnull
public DBJob setRunnerSession(com.aspc.dal.job.DBJobManagerSession value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

getStartedTS

@CheckReturnValue
 @Nullable
public java.util.Date getStartedTS(java.lang.String... args)

setStartedTS

@Nonnull
public DBJob setStartedTS(java.util.Date value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

getStatistic

@CheckReturnValue
 @Nullable
public DBJobStatistic getStatistic(java.lang.String... args)

findStatistic

@CheckReturnValue
 @Nonnull
public final DBJobStatistic findStatistic(java.lang.String... args)
                                                               throws NotFoundException

the statistic record.

--> DBJobStatistic (Integer, Searchable)

Parameters:: args - the optional arguments
Returns:: DBJobStatistic
Throws:: NotFoundException - DBJobStatistic was not found

setStatistic

@Nonnull
public DBJob setStatistic(com.aspc.dal.job.statistic.DBJobStatistic value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

setStatus

@Nonnull
public DBJob setStatus(com.aspc.dal.job.DBJobStatus value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:: java.lang.Exception

getTargetName

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

setTargetName

@Nonnull
public DBJob setTargetName(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getTargetSession

@CheckReturnValue
 @Nullable
public DBJobManagerSession getTargetSession(java.lang.String... args)

findTargetSession
```
@CheckReturnValue
 @Nonnull
public final DBJobManagerSession findTargetSession(java.lang.String... args)
                                                                        throws NotFoundException
```
The target job manager for this job. Only the job manager for this session will run this job.

--> DBJobManagerSession (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBJobManagerSession

Throws:

NotFoundException - DBJobManagerSession was not found

setTargetSession

@Nonnull
public DBJob setTargetSession(com.aspc.dal.job.DBJobManagerSession value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:: java.lang.Exception

getTerminatedBy

@CheckReturnValue
 @Nullable
public Person getTerminatedBy(java.lang.String... args)

findTerminatedBy
```
@CheckReturnValue
 @Nonnull
public final Person findTerminatedBy(java.lang.String... args)
                                                          throws NotFoundException
```
The ID of the person that cancelled/killed this JOB.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setTerminatedBy

@Nonnull
public DBJob setTerminatedBy(com.aspc.dal.dbobj.contact.Person value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:: java.lang.Exception

getTimeZone

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

setTimeZone

@Nonnull
public DBJob setTimeZone(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:: java.lang.Exception

getTotalTime

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

getTotalTimeMS

@CheckReturnValue
public long getTotalTimeMS(java.lang.String... args)

getUserId

@CheckReturnValue
 @Nullable
public Login getUserId(java.lang.String... args)

findUserId

@CheckReturnValue
 @Nonnull
public final Login findUserId(java.lang.String... args)
                                                   throws NotFoundException

Who the job is for.

--> Login (String, Mandatory, Searchable)

Parameters:: args - the optional arguments
Returns:: Login
Throws:: NotFoundException - Login was not found

setUserId

@Nonnull
public DBJob setUserId(com.aspc.dal.dbobj.contact.Login value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:: java.lang.Exception

isWaitCheckSuccessfulForJobs

@CheckReturnValue
public boolean isWaitCheckSuccessfulForJobs(java.lang.String... args)

setWaitCheckSuccessfulForJobs

@Nonnull
public DBJob setWaitCheckSuccessfulForJobs(boolean value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:: java.lang.Exception

getWaitForJob

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getWaitForJob(java.lang.String... args)

setWaitForJob

@Nonnull
public DBJob setWaitForJob(java.util.List<java.lang.String> value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:: java.lang.Exception

getWarningTx

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

setWarningTx

@Nonnull
public DBJob setWarningTx(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:: java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBJob create(@Nonnull
                                                       MutableDataSource mds)
                                                throws java.lang.Exception

Make a new instance of this class.

Parameters:: mds - the datasource
Returns:: the new record
Throws:: java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBJob> makeQuery(@Nonnull
                                                                   DataSource ds)
                                                            throws NotFoundException

Make a new QUERY for this class.

Parameters:: ds - the datasource
Returns:: the new QUERY
Throws:: NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static DBJob findKey(@Nonnull
                                                        DataSource ds,
                                                        int key)
                                                 throws NotFoundException,
                                                        java.lang.Exception

Find the target for this class by the primary key

Parameters:: ds - the datasource; key - the value
Returns:: the target
Throws:: NotFoundException - if target could not be found; java.lang.Exception - a serious problem

extFixUp
```
@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception
```
Description copied from class: DBObject

The extended fix up routine

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

setExcuteConnection
```
public void setExcuteConnection(Connection connection)
```
set the connection

Parameters:

connection - the connection

getExcuteConnection
```
public Connection getExcuteConnection()
```
the connection

Returns:

the connection

getStatus
```
public java.lang.String getStatus()
```
A short hand method to get the status of the job. This method also provides a secondary cache * on this field.

Returns:

The status

displayName
```
@CheckReturnValue
 @Nonnull
public java.lang.String displayName()
```
The human readable job name

Overrides:

displayName in class DBObject

Returns:

The display name for this job.

makeJobKey
```
public static GlobalKey makeJobKey(java.lang.String jobId)
                            throws java.lang.Exception
```
Makes a global key from an ASCII key

Parameters:

jobId - The ASCII job id

Returns:

The Job global key.

Throws:

java.lang.Exception - A serious problem

getJobID
```
public java.lang.String getJobID()
```
An human readable version of the job's global id.

Returns:

The ASCII job id

makeID
```
public static java.lang.String makeID(GlobalId jobId)
```
make the display name

Parameters:

jobId - the key

Returns:

the display name

encodedResults
```
public java.lang.String encodedResults(java.lang.String encoding)
                                throws java.lang.Exception
```
The compressed and encoded version of the results

Parameters:

encoding - The encoding GZIP, DEFLATE or NONE

Returns:

The encoded/compressed results

Throws:

java.lang.Exception - A serious problem

waitToComplete
```
public java.lang.String waitToComplete(long timeout)
                                throws java.lang.InterruptedException
```
Wait for this job to complete for an amount of time.

Parameters:

timeout - How long to wait in Milliseconds.

Returns:

The current status.

Throws:

java.lang.InterruptedException - The wait was interrupted

forceToDB
```
public boolean forceToDB(java.lang.String message)
                  throws java.lang.Exception
```
Repeatedly try to write this job to the database. Database concurrency We loop on dirty cache exceptions where to force the write to the database.

Parameters:

message - The save message

Returns:

TRUE if the job was saved.

Throws:

java.lang.Exception - A serious problem

writeToDB
```
public boolean writeToDB(@Nonnull
                         java.lang.String message)
                  throws java.lang.Exception
```
Write the JOB to the database if it isn't new ( EXECUTEd)
Database concurrency We expect to get dirty cache exceptions where and we DO NOT retry the statement.

Parameters:

message - The save message

Returns:

TRUE if the JOB was saved

Throws:

java.lang.Exception - A serious problem

setMinCommandFileSize
```
public static void setMinCommandFileSize(long bytes)
```
The min size of the commands before we would create a file instead of a simple text file

Parameters:

bytes - The minimum size.

getMinCommandFileSize
```
public static long getMinCommandFileSize()
```
The min size of the commands before we would create a file instead of a simple text file

Returns:

The min size

setMinResultFileSize
```
public static void setMinResultFileSize(long bytes)
```
The min size of the commands before we would create a file instead of a simple text file

Parameters:

bytes - The minimum size of the file

getMinResultFileSize
```
public static long getMinResultFileSize()
```
The min size of the commands before we would create a file instead of a simple text file

Returns:

The min size

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

check the status.

Overrides:: eventFieldUpdated in class DBObject
Parameters:: field - The field updated; previous - the previous value; previousKey - The previous key; params - the parameters
Throws:: java.lang.Exception - a serious problem

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

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. OVERRIDE this method to add additional validations to a record.
The MutableDataSource is in READONLY mode at this stage.

Overrides:: extValidateRecord in class DBObject
Parameters:: list - The validation list.
Throws:: java.lang.Exception - A serious problem

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:: extValidateField in class DBObject
Parameters:: list - The validation list; field - The field to be validated
Returns:: The validation error
Throws:: java.lang.Exception - A serious problem

setCommand
```
public void setCommand(java.lang.String command)
                throws java.lang.Exception
```
The commands to be processed.

Parameters:

command - The commands

Throws:

java.lang.Exception - A serious problem

setResult
```
public void setResult(java.lang.String results)
               throws java.lang.Exception
```
The results

Parameters:

results - The results

Throws:

java.lang.Exception - A serious problem

cancel
```
public void cancel()
            throws java.lang.Exception
```
cancel the job

Throws:

java.lang.Exception - A serious problem

releaseMemory
```
public void releaseMemory()
```
Release all the memory held by this JOB

waitStartToComplete
```
public void waitStartToComplete()
                         throws java.lang.Exception
```
wait for the job "on start" script to complete

Throws:

java.lang.Exception - a serious problem.

extSetValue
```
protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception
```
1) Control the setting of status 2) Don't allow the user to set maxHeartBeatDurationMS we will calculate this. 3) Don't allow the raw commands and results to be set by a user 4) Don't allow result size to be set by the user.

Overrides:

extSetValue in class DBObject

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

java.lang.Exception - A serious problem

extPreValidate
```
@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception
```
Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

extPreValidateDelete
```
@OverridingMethodsMustInvokeSuper
protected void extPreValidateDelete()
                                                               throws java.lang.Exception
```
Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS FOR DELETED RECORDS.

Overrides:

extPreValidateDelete in class DBObject

Throws:

java.lang.Exception - a serious problem

extPreDeleteRecord
```
@OverridingMethodsMustInvokeSuper
protected void extPreDeleteRecord()
                                                             throws java.lang.Exception
```
Additional functionality WHILE saving this record to the database.

Overrides:

extPreDeleteRecord in class DBObject

Throws:

java.lang.Exception - A serious problem

extPreSaveRecord
```
@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception
```
Additional functionality WHILE saving this record to the database.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A serious problem

extPostDeleteRecord

@OverridingMethodsMustInvokeSuper
protected void extPostDeleteRecord(@Nonnegative
                                                                     long transNr)

run the on complete commands

Overrides:: extPostDeleteRecord in class DBObject
Parameters:: transNr - The current transaction

extPostSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)