com.jcorporate.expresso.services.dbobj
Class UserPreference

java.lang.Object
  com.jcorporate.expresso.core.dataobjects.BaseDataObject
      com.jcorporate.expresso.core.dataobjects.jdbc.JDBCDataObject
          com.jcorporate.expresso.core.dbobj.DBObject
              com.jcorporate.expresso.core.dbobj.SecuredDBObject
                  com.jcorporate.expresso.services.dbobj.SecurityDBObject
                      com.jcorporate.expresso.services.dbobj.UserPreference

All Implemented Interfaces:

Cacheable, ContextNested, DataObject, LookupInterface, Securable, Serializable, UserListener

public class UserPreference

extends SecurityDBObject

implements UserListener

A User Preference is a stored value or attribute that is related to a particular user. This value set a preference or customizes the behaviour of a particular application when used by this user.

Author:

Michael Nash

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class com.jcorporate.expresso.core.dbobj.DBObject

DBObject.FieldError, DBObject.FieldUpdate

Field Summary

static String	CLASS_NAME
static String	EXPUID
static String	PREF_CODE
static String	PREF_VALUE

Fields inherited from class com.jcorporate.expresso.services.dbobj.SecurityDBObject

SECURITY_CONTEXT, SECURITY_OBJECTS

Fields inherited from class com.jcorporate.expresso.core.dbobj.SecuredDBObject

ADD, ALL_FUNCTIONS, CACHE_NAME, CACHE_TTY, DELETE, SEARCH, SYSTEM_ACCOUNT, SYSTEM_ACCOUNT_NAME, UPDATE

Fields inherited from class com.jcorporate.expresso.core.dbobj.DBObject

ATTRIBUTE_ERROR, ATTRIBUTE_ERROR_MESSAGE, ATTRIBUTE_PAGE_LIMIT, BIG_DECIMAL_ZERO, EMAIL_MASK, EVENT_ADD, EVENT_DELETE, EVENT_UPDATE, FLOAT_MASK, INT_MASK, IS_CHECK_RELATIONAL_INTEGRITY, UPDATE_CHANGED_ONLY, WHERE_KEYWORD

Fields inherited from class com.jcorporate.expresso.core.dataobjects.jdbc.JDBCDataObject

anyFieldsDistinct, anyFieldsToRetrieve, appendCustomWhere, caseSensitiveQuery, customWhereClause, dbKey, distinctFields, localConnection, LONGBINARY_READ_DEFAULT_SIZE, maxRecords, myClassName, myUpdates, offsetRecord, recordSet, retrieveFields, sMetadataMap, sortKeys

Fields inherited from class com.jcorporate.expresso.core.dataobjects.BaseDataObject

currentStatus, globalMask

Fields inherited from interface com.jcorporate.expresso.core.dataobjects.DataObject

STATUS_CURRENT, STATUS_DELETED, STATUS_NEW, STATUS_UPDATED

Constructor Summary

UserPreference()

UserPreference(ControllerRequest request)
For using DBObjects within Controllers.

UserPreference(int uid)
Use over (String) constructor.

Method Summary

void	addedUser(User user) This method is called just after a new user is added Creation date: (5/12/2001 2:26:17 PM)
protected void	checkAllRefs() Extends the checkAllRefs method to check for valid UserGroup
void	deletedUser(User user) This method is called just before a user is deleted Creation date: (5/12/2001 2:26:17 PM)
String	getField(String fieldName) Get the string value of a field in this object as a string
void	loggedOffUser(User user) This method is called just before a user is logged off Creation date: (5/12/2001 2:26:17 PM)
void	loggedOnUser(User user) This method is called just after a user is logged on Creation date: (5/12/2001 2:26:17 PM)
void	modifiedUser(User user) This method is called just after a user is modified Creation date: (5/12/2001 2:26:17 PM)
void	setupFields() Method to set up the fields for this database object.

Methods inherited from class com.jcorporate.expresso.services.dbobj.SecurityDBObject

overrideDataContext, setDataContext, setDBName

Methods inherited from class com.jcorporate.expresso.core.dbobj.SecuredDBObject

add, canRequesterAdd, canRequesterDelete, canRequesterRead, canRequesterUpdate, checkAllowed, copyAttributes, count, createSecurityCache, delete, deleteAll, find, getRequestingUid, getString, getString, getString, getString, getString, getString, getSystemUid, instantiate, isAllowed, retrieve, search, searchAndRetrieveList, searchAndRetrieveList, setRequestingUid, update

Methods inherited from class com.jcorporate.expresso.core.dbobj.DBObject

addDetail, addField, addField, addFieldError, addFoundKeys, addIfNeeded, addIndex, addKey, addOrUpdate, addSortKey, addTransition, addVirtualField, addVirtualField, addVirtualField, addVirtualField, average, basicAdd, cacheIsChangedComparison, checkAllReferredToBy, checkAllRefsPublic, checkDeleteDetailPerm, checkField, checkRef, checkRef, clear, clearDistinctFields, clearError, clearFieldsToRetrieve, clearSortKeys, containsWildCards, delete, deleteAll, deleteDetails, denotesRange, equals, forKey, formatDateTime, get, getAllAttributes, getAttribute, getAttributesIterator, getBooleanFieldValue, getCacheSize, getCacheStatsMap, getCacheUtil, getCheckZeroUpdate, getCustomWhereClause, getDataContext, getDataField, getDataTransferObject, getDBName, getDetails, getDistinctFieldCount, getDistinctFields, getFieldBigDecimal, getFieldBoolean, getFieldByte, getFieldByteArray, getFieldData, getFieldDate, getFieldDecimalFormatted, getFieldDouble, getFieldErrorMessage, getFieldFloat, getFieldInt, getFieldLong, getFieldMetaData, getFieldShort, getFieldsToRetrieveCount, getFilterClass, getFoundCount, getFoundKeysArray, getIndexArray, getISOValuesDefault, getISOValuesDefault, getISOValuesDefault, getKey, getKeyFieldListIterator, getLength, getLengthInt, getLocalConnection, getLocale, getLogger, getLookupObject, getMax, getMax, getMaxRecords, getMyKeys, getMyUpdatesArray, getOffsetRecord, getPatternMatcher, getPrecision, getSerializedForm, getStringFilter, getThisDBbj, getThisDBObj, getValidValueDescrip, getValidValues, getValidValuesList, getValues, getValuesDefault, getValuesDefault, getValuesDefault, hasError, hasErrors, haveAllKeys, initialize, isCached, isChanged, isDistinct, isEmpty, isFieldDistinct, isFieldNull, isFieldsToRetrieve, isFieldToRetrieve, isMultiValued, isReadOnly, isSecret, isVirtual, loadFromConnection, logChange, max, min, newInstance, noNewLine, noQuotes, notifyListeners, populateDefaultValues, referredToBy, removeAttribute, removeFromCache, retrieveFromCache, saveBinaryField, search, set, setAttribute, setCacheSize, setCharset, setCheckZeroUpdate, setConnection, setConnection, setCustomWhereClause, setCustomWhereClause, setDataField, setDataTransferObject, setDefaultValue, setDescription, setField, setField, setField, setField, setField, setField, setField, setField, setField, setField, setFieldData, setFieldData, setFieldDistinct, setFieldsToRetrieve, setFilterClass, setFilterClass, setKeys, setLocale, setLookupField, setLookupObject, setMask, setMaxRecords, setMultiValued, setName, setOffsetRecord, setReadOnly, setSchema, setSecret, setSortKey, setStringFilter, setStringFiltersOnAll, setTargetDbSchema, setTargetTable, sqlAggrFunction, sum, toDebugString, update, updateAll, updateAll, verify

Methods inherited from class com.jcorporate.expresso.core.dataobjects.jdbc.JDBCDataObject

addInParam, addOutParam, buildWhereClause, buildWhereClauseBuffer, checkZeroUpdate, constructNewMetaData, createAndExecuteSearch, createAndRunStoreProcedure, getConnectionPool, getCustomStringFieldValue, getDef, getDistinctFieldArrayList, getExecutor, getFieldsToRetrieveIterator, getJDBCMetaData, getJDBCUtil, getMappedDataContext, getMetaData, getQueryInterface, getSerialForm, loadFromConnection, makeLimitationStub, quoteIfNeeded, runStoredProcedure, runStoredProcedureAndRetrieveList, selectFieldString, setCaseSensitiveQuery, setDBConnectionPool, setMappedDataContext, setOriginalDBName, setTargetStoreProcedure

Methods inherited from class com.jcorporate.expresso.core.dataobjects.BaseDataObject

getGlobalMask, getStatus, isGlobalMasked, setFieldsWithDefaults, setGlobalMask, setStatus

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREF_CODE

public static final String PREF_CODE

See Also:

Constant Field Values

PREF_VALUE

public static final String PREF_VALUE

See Also:

Constant Field Values

CLASS_NAME

public static final String CLASS_NAME

See Also:

Constant Field Values

EXPUID

public static final String EXPUID

See Also:

Constant Field Values

Constructor Detail

UserPreference

public UserPreference()
               throws DBException

See Also:

SecuredDBObject.SecuredDBObject(java.lang.String, int)

UserPreference

public UserPreference(int uid)
               throws DBException

Use over (String) constructor. Initializes the object in the context of the user who's uid belongs to the parameter.

Parameters:

uid - of the user context

Throws:

DBException - if there's an initialization problem

UserPreference

public UserPreference(ControllerRequest request)
               throws DBException

For using DBObjects within Controllers. Initializes based upon the current user and the requested db. [Of course this can be modified later]

Parameters:

request - - The controller request handed to you by the framework.

Method Detail

addedUser

public void addedUser(User user)
               throws DBException

Description copied from interface: UserListener

This method is called just after a new user is added Creation date: (5/12/2001 2:26:17 PM)

Specified by:

addedUser in interface UserListener

Parameters:

user - com.jcorporate.expresso.core.security.User

Throws:

DBException

checkAllRefs

protected void checkAllRefs()
                     throws DBException

Extends the checkAllRefs method to check for valid UserGroup

Overrides:

checkAllRefs in class DBObject

Throws:

DBException - If a referential integrity violation is found

deletedUser

public void deletedUser(User user)
                 throws DBException

Description copied from interface: UserListener

This method is called just before a user is deleted Creation date: (5/12/2001 2:26:17 PM)

Specified by:

deletedUser in interface UserListener

Parameters:

user - com.jcorporate.expresso.core.security.User

Throws:

DBException

loggedOffUser

public void loggedOffUser(User user)
                   throws DBException

Description copied from interface: UserListener

This method is called just before a user is logged off Creation date: (5/12/2001 2:26:17 PM)

Specified by:

loggedOffUser in interface UserListener

Parameters:

user - com.jcorporate.expresso.core.security.User

Throws:

DBException

loggedOnUser

public void loggedOnUser(User user)
                  throws DBException

Description copied from interface: UserListener

This method is called just after a user is logged on Creation date: (5/12/2001 2:26:17 PM)

Specified by:

loggedOnUser in interface UserListener

Parameters:

user - com.jcorporate.expresso.core.security.User

Throws:

DBException

modifiedUser

public void modifiedUser(User user)
                  throws DBException

Description copied from interface: UserListener

This method is called just after a user is modified Creation date: (5/12/2001 2:26:17 PM)

Specified by:

modifiedUser in interface UserListener

Parameters:

user - com.jcorporate.expresso.core.security.User

Throws:

DBException

setupFields

public void setupFields()
                 throws DBException

Description copied from class: DBObject

Method to set up the fields for this database object. This method should be defined in the implementing object and should make calls to addField, addKey, setMultiValued, etc. as required to define the content of the DBObject. Each setupFields method should call "super.setupFields()" so that field definitions can be "inheritcable"

Overrides:

setupFields in class DBObject

Throws:

DBException - If there is an error setting up the fields as requested. For example, if a field allowing null is requested as part of the key

See Also:

Note that valid values for PREF_VALUE may be specified in UserPreferenceVal, depending on the preference.

getField

public String getField(String fieldName)
                throws DBException

Description copied from class: DBObject

Get the string value of a field in this object as a string

Specified by:

getField in interface DataObject

Overrides:

getField in class DBObject

Parameters:

fieldName - Name of the field to fetch

Returns:

The value of the given field as a string - if the field is null, an empty string is returned.

Throws:

DBException - If there is no such field or it's value cannot be accessed