com.aspc.Layers.aspc_app.ControlPanel

Class CPModule

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.ControlPanel.CPModule

All Implemented Interfaces:

SecondaryCacheGroup

public class CPModule
extends DBObject

Task is a
Defines the modules that appear in the left hand pane of the control panel.

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

Since:

November 10, 2003, 9:41 AM

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 Defines the modules that appear in the left hand pane of the control panel
static java.lang.String	DBCLASS_NAME Defines the modules that appear in the left hand pane of the control panel

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static CPModule	create(MutableDataSource mds) Make a new instance of this class.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
DBFile	findIcon(java.lang.String... args) Icon.
static CPModule	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
DBModule	findModule(java.lang.String... args) Module that this entry is related to.
java.lang.String	getAltText(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
DBFile	getIcon(java.lang.String... args)
DBModule	getModule(java.lang.String... args)
DBObject[]	getModuleControls()
java.lang.String	getName(java.lang.String... args)
DBObject[]	getPermissions()
int	getSeq(java.lang.String... args)
java.lang.String	getTarget(java.lang.String... args)
java.lang.String	getToolTip(java.lang.String... args)
java.lang.String	getUrl(java.lang.String... args)
boolean	hasReadAccess(java.lang.String... args)
boolean	hideFg(java.lang.String... args)
boolean	isActive(java.lang.String... args)
static DBQuery<CPModule>	makeQuery(DataSource ds) Make a new QUERY for this class.
CPModule	setAltText(java.lang.String value, java.lang.String... args)
CPModule	setCode(java.lang.String value, java.lang.String... args)
CPModule	setHideFg(boolean value, java.lang.String... args)
CPModule	setIcon(com.aspc.dal.file.DBFile value, java.lang.String... args)
CPModule	setModule(com.aspc.dal.dbobj.module.DBModule value, java.lang.String... args)
CPModule	setName(java.lang.String value, java.lang.String... args)
CPModule	setSeq(int value, java.lang.String... args)
CPModule	setTarget(java.lang.String value, java.lang.String... args)
CPModule	setToolTip(java.lang.String value, java.lang.String... args)
CPModule	setUrl(java.lang.String 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, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, 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

Defines the modules that appear in the left hand pane of the control panel

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Defines the modules that appear in the left hand pane of the control panel

Constructor Detail

CPModule

public CPModule(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 CPModule setCode(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getAltText

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

setAltText

@Nonnull
public CPModule setAltText(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

hasReadAccess

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

hideFg

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

setHideFg

@Nonnull
public CPModule setHideFg(boolean value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getIcon

@CheckReturnValue
 @Nullable
public DBFile getIcon(java.lang.String... args)

findIcon

@CheckReturnValue
 @Nonnull
public final DBFile findIcon(java.lang.String... args)
                                                  throws NotFoundException

Icon.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setIcon

@Nonnull
public CPModule setIcon(com.aspc.dal.file.DBFile value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isActive

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

getModule

@CheckReturnValue
 @Nullable
public DBModule getModule(java.lang.String... args)

findModule

@CheckReturnValue
 @Nonnull
public final DBModule findModule(java.lang.String... args)
                                                      throws NotFoundException

Module that this entry is related to.

--> DBModule (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Module

Throws:

NotFoundException - DBModule was not found

setModule

@Nonnull
public CPModule setModule(com.aspc.dal.dbobj.module.DBModule 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 CPModule setName(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getSeq

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

setSeq

@Nonnull
public CPModule setSeq(int value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getTarget

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

setTarget

@Nonnull
public CPModule setTarget(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getToolTip

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

setToolTip

@Nonnull
public CPModule setToolTip(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getUrl

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

setUrl

@Nonnull
public CPModule setUrl(java.lang.String value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static CPModule 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<CPModule> 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 CPModule 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

getPermissions

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

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getModuleControls

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

Returns:

the value

Throws:

java.lang.Exception - a serious problem

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 calculated value

Throws:

java.lang.Exception - A serious problem