com.aspc.job

Class DBQueue

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.job.DBQueue

All Implemented Interfaces:

SecondaryCacheGroup

public class DBQueue
extends DBObject

The queue 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 The queue for a job.
static java.lang.String	DBCLASS_NAME The queue for a job.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBQueue	create(MutableDataSource mds) Make a new instance of this class.
static DBQueue	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getDefaultMaxRunTime(java.lang.String... args)
int	getDefaultRetryCount(java.lang.String... args)
java.lang.String	getLabel(java.lang.String... args)
java.lang.String	getMaxRunTime(java.lang.String... args)
int	getMaxSize(java.lang.String... args)
java.lang.String	getMaxWaitTime(java.lang.String... args)
int	getMaxWorkerSlots(java.lang.String... args)
boolean	isEnabled(java.lang.String... args)
boolean	isRequeueOnManagerDisable(java.lang.String... args)
static DBQuery<DBQueue>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBQueue	setCode(java.lang.String value, java.lang.String... args)
DBQueue	setDefaultMaxRunTime(java.lang.String value, java.lang.String... args)
DBQueue	setDefaultRetryCount(int value, java.lang.String... args)
DBQueue	setEnabled(boolean value, java.lang.String... args)
DBQueue	setLabel(java.lang.String value, java.lang.String... args)
DBQueue	setMaxRunTime(java.lang.String value, java.lang.String... args)
DBQueue	setMaxSize(int value, java.lang.String... args)
DBQueue	setMaxWaitTime(java.lang.String value, java.lang.String... args)
DBQueue	setMaxWorkerSlots(int value, java.lang.String... args)
DBQueue	setRequeueOnManagerDisable(boolean value, java.lang.String... args)

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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, 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

The queue for a job.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The queue for a job.

Constructor Detail

DBQueue

public DBQueue(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

getCode

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

setCode

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

Throws:

java.lang.Exception

getDefaultMaxRunTime

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

setDefaultMaxRunTime

@Nonnull
public DBQueue setDefaultMaxRunTime(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultRetryCount

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

setDefaultRetryCount

@Nonnull
public DBQueue setDefaultRetryCount(int value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

isEnabled

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

setEnabled

@Nonnull
public DBQueue setEnabled(boolean value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getLabel

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

setLabel

@Nonnull
public DBQueue setLabel(java.lang.String 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 DBQueue setMaxRunTime(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getMaxSize

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

setMaxSize

@Nonnull
public DBQueue setMaxSize(int value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getMaxWaitTime

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

setMaxWaitTime

@Nonnull
public DBQueue setMaxWaitTime(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getMaxWorkerSlots

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

setMaxWorkerSlots

@Nonnull
public DBQueue setMaxWorkerSlots(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isRequeueOnManagerDisable

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

setRequeueOnManagerDisable

@Nonnull
public DBQueue setRequeueOnManagerDisable(boolean value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBQueue 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<DBQueue> 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 DBQueue findKey(@Nonnull
                                                          DataSource ds,
                                                          @Nonnull
                                                          java.lang.String 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