com.aspc.pref.screen

Class SDBComponentPref

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.pref.DBPref

com.aspc.pref.screen.SDBComponentPref

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

SDBColumnPref, SDBContainerPref

public class SDBComponentPref
extends DBPref

holds the preferences for a screen component.

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 holds the preferences for a screen component.
static java.lang.String	DBCLASS_NAME holds the preferences for a screen component.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	extFixUp() fixes the following problem 1) user been removed
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Handles the calculation of values for derived fields
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
static DBPrefGroup	fetchPrefGroup(Login login, SDBComponent component) Fetch the preference group for this user & component
SDBComponent	findComponent(java.lang.String... args) the component for this prefs.
SDBViewControlMode	findVisibility(java.lang.String... args) Should this component be shown or hidden ?.
SDBComponent	getComponent(java.lang.String... args)
int	getDerivedComponentCol(java.lang.String... args)
java.lang.String	getDerivedComponentFieldPathDesc(java.lang.String... args)
protected SDBComponent	getSudoComponent()
SDBViewControlMode	getVisibility(java.lang.String... args)
int	getWidth(java.lang.String... args)
boolean	isDerivedComponentHidden(java.lang.String... args)
boolean	isHidden(java.lang.String... args)
SDBComponentPref	setComponent(com.supertracker.dal.screenobj.SDBComponent value, java.lang.String... args)
SDBComponentPref	setHidden(boolean value, java.lang.String... args)
SDBComponentPref	setVisibility(com.supertracker.dal.screenobj.viewcontrol.SDBViewControlMode value, java.lang.String... args)
SDBComponentPref	setWidth(int value, java.lang.String... args)

Methods inherited from class com.aspc.pref.DBPref

create, findKey, findPrefGroup, getID, getPrefGroup, isActive, makeQuery, setID, setPrefGroup

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, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

holds the preferences for a screen component.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

holds the preferences for a screen component.

Constructor Detail

SDBComponentPref

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

getComponent

@CheckReturnValue
 @Nullable
public SDBComponent getComponent(java.lang.String... args)

findComponent

@CheckReturnValue
 @Nonnull
public final SDBComponent findComponent(java.lang.String... args)
                                                             throws NotFoundException

the component for this prefs.

--> SDBComponent (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBComponent

Throws:

NotFoundException - SDBComponent was not found

setComponent

@Nonnull
public SDBComponentPref setComponent(com.supertracker.dal.screenobj.SDBComponent value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getDerivedComponentCol

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

getDerivedComponentFieldPathDesc

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

isDerivedComponentHidden

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

isHidden

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

setHidden

@Nonnull
public SDBComponentPref setHidden(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getVisibility

@CheckReturnValue
 @Nullable
public SDBViewControlMode getVisibility(java.lang.String... args)

findVisibility

@CheckReturnValue
 @Nonnull
public final SDBViewControlMode findVisibility(java.lang.String... args)
                                                                    throws NotFoundException

Should this component be shown or hidden ?.

--> .SDBViewControlMode SDBViewControlMode (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBViewControlMode

Throws:

NotFoundException - SDBViewControlMode was not found

setVisibility

@Nonnull
public SDBComponentPref setVisibility(com.supertracker.dal.screenobj.viewcontrol.SDBViewControlMode value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getWidth

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

setWidth

@Nonnull
public SDBComponentPref setWidth(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

extGetDerivedValue

@CheckReturnValue
 @Nullable
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                           DBField field,
                                                                           @Nullable
                                                                           FldParams params)
                                                                    throws java.lang.Exception

Description copied from class: DBPref

Handles the calculation of values for derived fields

Overrides:

extGetDerivedValue in class DBPref

Parameters:

field - The derived field that a value is required for

params - Field parameters providing information for the calculation of values

Returns:

The calculated value

Throws:

java.lang.Exception - a serious problem

getSudoComponent

protected SDBComponent getSudoComponent()
                                 throws java.lang.Exception

Throws:

java.lang.Exception

fetchPrefGroup

public static DBPrefGroup fetchPrefGroup(Login login,
                                         SDBComponent component)
                                  throws java.lang.Exception

Fetch the preference group for this user & component

Parameters:

login - - the login that group is to be retrieved for

component - - Screen component that requires preferences

Returns:

- the preferences for supplied user/component

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 DBPref

Throws:

java.lang.Exception - a serious problem