com.aspc.Layers.aspc_app.online_request

Class OnlineRequestOptionMap

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.online_request.OnlineRequestOptionMap

All Implemented Interfaces:

SecondaryCacheGroup

public class OnlineRequestOptionMap
extends DBObject

Provides options for an online request.

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

Since:

March 12, 2007, 9:41 AM

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 Provides options for an online request
static java.lang.String	DBCLASS_NAME Provides options for an online request

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static OnlineRequestOptionMap	create(MutableDataSource mds) Make a new instance of this class.
static OnlineRequestOptionMap	findKey(DataSource ds, int key) Find the target for this class by the primary key
OnlineRequest	findOnlineRequest(java.lang.String... args) Associated online request.
OnlineRequestOption	findOption(java.lang.String... args) Associated option.
int	getID(java.lang.String... args)
OnlineRequest	getOnlineRequest(java.lang.String... args)
OnlineRequestOption	getOption(java.lang.String... args)
static DBQuery<OnlineRequestOptionMap>	makeQuery(DataSource ds) Make a new QUERY for this class.
OnlineRequestOptionMap	setID(int value, java.lang.String... args)
OnlineRequestOptionMap	setOnlineRequest(com.aspc.dal.layers.aspc_app.online_request.OnlineRequest value, java.lang.String... args)
OnlineRequestOptionMap	setOption(com.aspc.dal.layers.aspc_app.online_request.OnlineRequestOption 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

Provides options for an online request

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Provides options for an online request

Constructor Detail

OnlineRequestOptionMap

public OnlineRequestOptionMap(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 OnlineRequestOptionMap setID(int value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getOnlineRequest

@CheckReturnValue
 @Nullable
public OnlineRequest getOnlineRequest(java.lang.String... args)

findOnlineRequest

@CheckReturnValue
 @Nonnull
public final OnlineRequest findOnlineRequest(java.lang.String... args)
                                                                  throws NotFoundException

Associated online request.

--> OnlineRequest (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

OnlineRequest

Throws:

NotFoundException - OnlineRequest was not found

setOnlineRequest

@Nonnull
public OnlineRequestOptionMap setOnlineRequest(com.aspc.dal.layers.aspc_app.online_request.OnlineRequest value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getOption

@CheckReturnValue
 @Nullable
public OnlineRequestOption getOption(java.lang.String... args)

findOption

@CheckReturnValue
 @Nonnull
public final OnlineRequestOption findOption(java.lang.String... args)
                                                                 throws NotFoundException

Associated option.

--> .OnlineRequestOption OnlineRequestOption (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

OnlineRequestOption

Throws:

NotFoundException - OnlineRequestOption was not found

setOption

@Nonnull
public OnlineRequestOptionMap setOption(com.aspc.dal.layers.aspc_app.online_request.OnlineRequestOption value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static OnlineRequestOptionMap 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<OnlineRequestOptionMap> 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 OnlineRequestOptionMap 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