com.aspc.sessionaction

Class SessionAction

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.sessionaction.SessionAction

All Implemented Interfaces:

SecondaryCacheGroup

public class SessionAction
extends DBObject

Actions to take in this session.

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

Since:

24 Oct 2013

Author:

Liam Itzhaki

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 Actions to take in this session
static java.lang.String	DBCLASS_NAME Actions to take in this session

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static SessionAction	create(MutableDataSource mds) Make a new instance of this class.
static SessionAction	findKey(DataSource ds, int key) Find the target for this class by the primary key
Session	findSession(java.lang.String... args) The user session.
SessionActionStatus	findStatus(java.lang.String... args) The action status.
SessionActionType	findType(java.lang.String... args) The action type.
java.lang.String	getAction(java.lang.String... args)
int	getID(java.lang.String... args)
Session	getSession(java.lang.String... args)
SessionActionStatus	getStatus(java.lang.String... args)
SessionActionType	getType(java.lang.String... args)
static DBQuery<SessionAction>	makeQuery(DataSource ds) Make a new QUERY for this class.
SessionAction	setAction(java.lang.String value, java.lang.String... args)
SessionAction	setID(int value, java.lang.String... args)
SessionAction	setSession(com.aspc.dal.dbobj.contact.Session value, java.lang.String... args)
SessionAction	setStatus(com.aspc.dal.sessionaction.SessionActionStatus value, java.lang.String... args)
SessionAction	setType(com.aspc.dal.sessionaction.SessionActionType 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

Actions to take in this session

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Actions to take in this session

Constructor Detail

SessionAction

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

Throws:

java.lang.Exception

getAction

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

setAction

@Nonnull
public SessionAction setAction(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getSession

@CheckReturnValue
 @Nullable
public Session getSession(java.lang.String... args)

findSession

@CheckReturnValue
 @Nonnull
public final Session findSession(java.lang.String... args)
                                                      throws NotFoundException

The user session.

--> Session (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Session

Throws:

NotFoundException - Session was not found

setSession

@Nonnull
public SessionAction setSession(com.aspc.dal.dbobj.contact.Session value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

@CheckReturnValue
 @Nullable
public SessionActionStatus getStatus(java.lang.String... args)

findStatus

@CheckReturnValue
 @Nonnull
public final SessionActionStatus findStatus(java.lang.String... args)
                                                                 throws NotFoundException

The action status.

--> SessionActionStatus (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

SessionActionStatus

Throws:

NotFoundException - SessionActionStatus was not found

setStatus

@Nonnull
public SessionAction setStatus(com.aspc.dal.sessionaction.SessionActionStatus value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public SessionActionType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final SessionActionType findType(java.lang.String... args)
                                                             throws NotFoundException

The action type.

--> SessionActionType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

SessionActionType

Throws:

NotFoundException - SessionActionType was not found

setType

@Nonnull
public SessionAction setType(com.aspc.dal.sessionaction.SessionActionType value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

create

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