com.aspc.pref.screen

Class SDBContainerPref

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.pref.DBPref

com.aspc.pref.screen.SDBComponentPref

com.aspc.pref.screen.SDBContainerPref

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

SDBPortalPref, SDBReportLayoutPref

public class SDBContainerPref
extends SDBComponentPref

A Container for sub component preferences.

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

Since:

4 January 2007

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 A Container for sub component preferences.
static java.lang.String	DBCLASS_NAME A Container for sub component preferences.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	copyIncludeField(DBObject orig, DBField field) Indicates if a field should be included in an object copy
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extCopy(DBObject target) Also copies the column preferences that link to this container preference
protected void	extDelete() Additional functionality when an object is marked for deletion by calling delete().
protected void	extFixUp() fixes the following problem 1) user been removed
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Gets the global key for a linked derived field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreSaveRecord() Additional functionality WHILE saving this record to the database.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) Don't allow the key field to be set by the user ( or from the screen)
protected ValidationError	extValidateField(DBField field, ValidationList list) Validates the fields of the restriction itself
protected void	extValidateRecord(ValidationList list) Perform validation on this record
SDBContainerPref	findCopyFrom(java.lang.String... args) copy the preferences from the linked container preference to this container preference.
SDBContainerPref	findMatchesSaveTo(java.lang.String... args) if there is a name in the saveTo field, this will find any SDBContainerPref that already has that name.
DBTriStateOption	findPrefProfileCurrent(java.lang.String... args) Is this Profile the current active profile.
DBReportType	findReportType(java.lang.String... args) type of the report or portal(portal has not been implemented yet), it could be classic report, pie chart or bar chart etc.
SDBContainerPref	getCopyFrom(java.lang.String... args)
java.lang.String	getKey(java.lang.String... args)
int	getListLimit(java.lang.String... args)
SDBContainerPref	getMatchesSaveTo(java.lang.String... args)
DBTriStateOption	getPrefProfileCurrent(java.lang.String... args)
java.lang.String	getPrefProfileName(java.lang.String... args)
DBReportType	getReportType(java.lang.String... args)
java.lang.String	getSaveTo(java.lang.String... args)
java.lang.String	getSummary(java.lang.String... args)
void	makeCurrent() Makes this container preference the current preference
SDBContainerPref	setCopyFrom(com.aspc.dal.pref.screen.SDBContainerPref value, java.lang.String... args)
SDBContainerPref	setKey(java.lang.String value, java.lang.String... args)
SDBContainerPref	setListLimit(int value, java.lang.String... args)
SDBContainerPref	setPrefProfileCurrent(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)
SDBContainerPref	setPrefProfileName(java.lang.String value, java.lang.String... args)
SDBContainerPref	setReportType(com.aspc.dal.pref.DBReportType value, java.lang.String... args)
SDBContainerPref	setSaveTo(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.pref.screen.SDBComponentPref

fetchPrefGroup, findComponent, findVisibility, getComponent, getDerivedComponentCol, getDerivedComponentFieldPathDesc, getSudoComponent, getVisibility, getWidth, isDerivedComponentHidden, isHidden, setComponent, setHidden, setVisibility, setWidth

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, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extDeleteRecord, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, 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

A Container for sub component preferences.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A Container for sub component preferences.

Constructor Detail

SDBContainerPref

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

getCopyFrom

@CheckReturnValue
 @Nullable
public SDBContainerPref getCopyFrom(java.lang.String... args)

findCopyFrom

@CheckReturnValue
 @Nonnull
public final SDBContainerPref findCopyFrom(java.lang.String... args)
                                                                throws NotFoundException

copy the preferences from the linked container preference to this container preference.

--> SDBContainerPref (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBContainerPref

Throws:

NotFoundException - SDBContainerPref was not found

setCopyFrom

@Nonnull
public SDBContainerPref setCopyFrom(com.aspc.dal.pref.screen.SDBContainerPref value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getKey

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

setKey

@Nonnull
public SDBContainerPref setKey(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getListLimit

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

setListLimit

@Nonnull
public SDBContainerPref setListLimit(int value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getMatchesSaveTo

@CheckReturnValue
 @Nullable
public SDBContainerPref getMatchesSaveTo(java.lang.String... args)

findMatchesSaveTo

@CheckReturnValue
 @Nonnull
public final SDBContainerPref findMatchesSaveTo(java.lang.String... args)
                                                                     throws NotFoundException

if there is a name in the saveTo field, this will find any SDBContainerPref that already has that name.

--> SDBContainerPref (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBContainerPref

Throws:

NotFoundException - SDBContainerPref was not found

getPrefProfileCurrent

@CheckReturnValue
 @Nullable
public DBTriStateOption getPrefProfileCurrent(java.lang.String... args)

findPrefProfileCurrent

@CheckReturnValue
 @Nonnull
public final DBTriStateOption findPrefProfileCurrent(java.lang.String... args)
                                                                          throws NotFoundException

Is this Profile the current active profile.

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setPrefProfileCurrent

@Nonnull
public SDBContainerPref setPrefProfileCurrent(com.aspc.dal.dbobj.misc.DBTriStateOption value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getPrefProfileName

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

setPrefProfileName

@Nonnull
public SDBContainerPref setPrefProfileName(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getReportType

@CheckReturnValue
 @Nullable
public DBReportType getReportType(java.lang.String... args)

findReportType

@CheckReturnValue
 @Nonnull
public final DBReportType findReportType(java.lang.String... args)
                                                              throws NotFoundException

type of the report or portal(portal has not been implemented yet), it could be classic report, pie chart or bar chart etc.

--> DBReportType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBReportType

Throws:

NotFoundException - DBReportType was not found

setReportType

@Nonnull
public SDBContainerPref setReportType(com.aspc.dal.pref.DBReportType value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getSaveTo

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

setSaveTo

@Nonnull
public SDBContainerPref setSaveTo(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSummary

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

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Perform validation on this record

Overrides:

extValidateRecord in class DBObject

Parameters:

list - the validation list

Throws:

java.lang.Exception - validation error

extGetDerivedValue

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

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class SDBComponentPref

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

- the calculated value

Throws:

java.lang.Exception - A serious problem

extGetDerivedGlobalKey

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

Gets the global key for a linked derived field.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - the derived field

params - the field parameters

Returns:

GlobalKey the global key of the linked field

Throws:

java.lang.Exception - a serious problem

extPreValidate

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

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Also copies the column preferences that link to this container preference

Overrides:

extCopy in class DBObject

Parameters:

target - the copy

Throws:

java.lang.Exception - an error in the copy

extDelete

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

Additional functionality when an object is marked for deletion by calling delete().

Overrides:

extDelete in class DBObject

Throws:

java.lang.Exception - A serious problem

copyIncludeField

@CheckReturnValue
public boolean copyIncludeField(@Nonnull
                                                  DBObject orig,
                                                  DBField field)
                                           throws java.lang.Exception

Indicates if a field should be included in an object copy

Overrides:

copyIncludeField in class DBObject

Parameters:

orig - the original object

field - the field to copy

Returns:

boolean true to include the field in the copy

Throws:

java.lang.Exception - a serious problem

makeCurrent

public void makeCurrent()
                 throws java.lang.Exception

Makes this container preference the current preference

Throws:

java.lang.Exception - a serious problem

extValidateField

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

Validates the fields of the restriction itself

Overrides:

extValidateField in class SDBComponentPref

Parameters:

list - The validation list

field - The field to validated

Returns:

The validation error or warning.

Throws:

java.lang.Exception - A serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

Don't allow the key field to be set by the user ( or from the screen)

Overrides:

extSetValue in class DBObject

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

java.lang.Exception - A serious problem

extFixUp

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

Description copied from class: SDBComponentPref

fixes the following problem 1) user been removed

Overrides:

extFixUp in class SDBComponentPref

Throws:

java.lang.Exception - a serious problem

extPreSaveRecord

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

Additional functionality WHILE saving this record to the database.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A serious problem