com.aspc.DBObj.Module

Class DBModule

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Module.DBModule

All Implemented Interfaces:

SecondaryCacheGroup

public class DBModule
extends DBObject

Modules can be enabled/disabled on a per user or per system bases.

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

Since:

26 June 2002

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 Modules can be enabled/disabled on a per user or per system bases.
static java.lang.String	DBCLASS_NAME Modules can be enabled/disabled on a per user or per system bases.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBModule	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventDataLoaded() When the underlying DBData is changed/ loaded.
protected void	extCheckDeleteAccess() Additional access checking for DELETE access for this object.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
ModuleAccessMode	findAccessMode(java.lang.String... args) Access Mode.
static DBModule	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
DBModuleMode	findMode(java.lang.String... args) Mode.
ModuleAccessMode	getAccessMode(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getDocumentationSeq(java.lang.String... args)
int	getLicenseNum(java.lang.String... args)
DBModuleMode	getMode(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
DBModule	getParentModule()
DBObject[]	getPermissions()
boolean	hasChildren(java.lang.String... args)
boolean	hasCreateAccess(java.lang.String... args)
boolean	hasDeleteAccess(java.lang.String... args)
boolean	hasFullAccess(java.lang.String... args)
boolean	hasModifyAccess(java.lang.String... args)
boolean	hasProxy(java.lang.String accessMode, Person owner, Person user) Determines if the specified user has been given proxy access to data of the current logged in user for the specified module
boolean	hasReadAccess(java.lang.String... args)
boolean	isActive(java.lang.String... args)
boolean	isHidden(java.lang.String... args)
static DBQuery<DBModule>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBModule	setAccessMode(com.aspc.dal.dbobj.misc.ModuleAccessModes value, java.lang.String... args)
DBModule	setCode(java.lang.String value, java.lang.String... args)
DBModule	setDescription(java.lang.String value, java.lang.String... args)
DBModule	setDocumentationSeq(java.lang.String value, java.lang.String... args)
DBModule	setHidden(boolean value, java.lang.String... args)
DBModule	setLicenseNum(int value, java.lang.String... args)
DBModule	setMode(com.aspc.dal.dbobj.module.DBModuleMode value, java.lang.String... args)
DBModule	setName(java.lang.String value, java.lang.String... args)
DBModule	setNotes(java.lang.String value, java.lang.String... args)
DBModule	setParentModule(com.aspc.dal.dbobj.module.DBModule 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, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, 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

Modules can be enabled/disabled on a per user or per system bases.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Modules can be enabled/disabled on a per user or per system bases.

Constructor Detail

DBModule

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

getCode

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

setCode

@Nonnull
public DBModule setCode(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getAccessMode

@CheckReturnValue
 @Nullable
public ModuleAccessMode getAccessMode(java.lang.String... args)

findAccessMode

@CheckReturnValue
 @Nonnull
public final ModuleAccessMode findAccessMode(java.lang.String... args)
                                                                  throws NotFoundException

Access Mode.

--> ModuleAccessModes (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ModuleAccessModes

Throws:

NotFoundException - ModuleAccessModes was not found

setAccessMode

@Nonnull
public DBModule setAccessMode(com.aspc.dal.dbobj.misc.ModuleAccessModes value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

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

setDescription

@Nonnull
public DBModule setDescription(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getDocumentationSeq

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

setDocumentationSeq

@Nonnull
public DBModule setDocumentationSeq(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

hasChildren

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

hasCreateAccess

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

hasDeleteAccess

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

hasFullAccess

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

hasModifyAccess

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

hasReadAccess

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

isHidden

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

setHidden

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

Throws:

java.lang.Exception

isActive

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

getLicenseNum

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

setLicenseNum

@Nonnull
public DBModule setLicenseNum(int value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getMode

@CheckReturnValue
 @Nullable
public DBModuleMode getMode(java.lang.String... args)

findMode

@CheckReturnValue
 @Nonnull
public final DBModuleMode findMode(java.lang.String... args)
                                                        throws NotFoundException

Mode.

--> DBModuleMode (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBModuleMode

Throws:

NotFoundException - DBModuleMode was not found

setMode

@Nonnull
public DBModule setMode(com.aspc.dal.dbobj.module.DBModuleMode value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public DBModule setName(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getNotes

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

setNotes

@Nonnull
public DBModule setNotes(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

setParentModule

@Nonnull
public DBModule setParentModule(com.aspc.dal.dbobj.module.DBModule value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBModule 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<DBModule> 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 DBModule findKey(@Nonnull
                                                           DataSource ds,
                                                           @Nonnull
                                                           java.lang.String 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

getParentModule

public DBModule getParentModule()

Returns:

the value

hasProxy

public boolean hasProxy(java.lang.String accessMode,
                        Person owner,
                        Person user)
                 throws java.lang.Exception

Determines if the specified user has been given proxy access to data of the current logged in user for the specified module

Parameters:

accessMode -

owner -

user - the user

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getPermissions

public DBObject[] getPermissions()
                          throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

eventDataLoaded

@OverridingMethodsMustInvokeSuper
protected void eventDataLoaded()

When the underlying DBData is changed/ loaded.

Overrides:

eventDataLoaded in class DBObject

extCheckDeleteAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException

Additional access checking for DELETE access for this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to delete this object

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 DBObject

Parameters:

field - The field to get

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

Returns:

the value

Throws:

java.lang.Exception - A serious problem

extFixUp

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

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem