com.aspc.pref.user

Class DBUserPrefGroup

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.pref.DBPrefGroup

com.aspc.pref.user.DBUserPrefGroup

All Implemented Interfaces:

SecondaryCacheGroup

public class DBUserPrefGroup
extends DBPrefGroup

preference group for a user.

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 preference group for a user.
static java.lang.String	DBCLASS_NAME preference group for a user.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	extFixUp() fixes the following problem 1) user been removed
static DBUserPrefGroup	fetchUserPrefGroup(Login login) Generates a preference group to store preferences for supplied user and component
Login	findUserId(java.lang.String... args) The user id for these preferences.
Login	getUserId(java.lang.String... args)
static DBUserPrefGroup	makeUserPrefGroup(Login login) Generates a preference group to store preferences for supplied user and component
DBUserPrefGroup	setUserId(com.aspc.dal.dbobj.contact.Login value, java.lang.String... args)

Methods inherited from class com.aspc.pref.DBPrefGroup

create, findKey, getID, makeQuery, setID

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, 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

preference group for a user.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

preference group for a user.

Constructor Detail

DBUserPrefGroup

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

getUserId

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

findUserId

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

The user id for these preferences.

--> Login (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Login

Throws:

NotFoundException - Login was not found

setUserId

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

Throws:

java.lang.Exception

makeUserPrefGroup

public static DBUserPrefGroup makeUserPrefGroup(Login login)
                                         throws java.lang.Exception

Generates a preference group to store preferences for supplied user and component

Parameters:

login - - login to generate preferences for

Returns:

- the new preference group

Throws:

java.lang.Exception - - a serious error

fetchUserPrefGroup

public static DBUserPrefGroup fetchUserPrefGroup(Login login)
                                          throws java.lang.Exception

Generates a preference group to store preferences for supplied user and component

Parameters:

login - - login to generate preferences for

Returns:

- the new preference group

Throws:

java.lang.Exception - - a serious error

extFixUp

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

fixes the following problem 1) user been removed

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem