com.aspc.Layers.aspc_app.ControlPanel

Class CPNewObject

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.ControlPanel.CPNewObject

All Implemented Interfaces:

SecondaryCacheGroup

public class CPNewObject
extends DBObject

Task is a
Defines an entry in the control panel 'create new objects links' frame.

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 an entry in the control panel 'create new objects links' frame
static java.lang.String	DBCLASS_NAME Defines an entry in the control panel 'create new objects links' frame

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static CPNewObject	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.
DBClassAbstract	findBaseClass(java.lang.String... args) Base Class.
static CPNewObject	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
DBModule	findModule(java.lang.String... args) Module.
SDBScreen	findScreen(java.lang.String... args) Screen.
ScreenTypes	findScreenType(java.lang.String... args) Screen Type.
DBClassAbstract	getBaseClass(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getLinkText(java.lang.String... args)
DBModule	getModule(java.lang.String... args)
DBObject[]	getModuleControls()
java.lang.String	getParams(java.lang.String... args)
DBObject[]	getPermissions()
SDBScreen	getScreen(java.lang.String... args)
ScreenTypes	getScreenType(java.lang.String... args)
int	getSeq(java.lang.String... args)
java.lang.String	getTarget(java.lang.String... args)
java.lang.String	getToolTip(java.lang.String... args)
int	getWindowHeight(java.lang.String... args)
int	getWindowWidth(java.lang.String... args)
boolean	hasReadAccess(java.lang.String... args)
boolean	hideFg(java.lang.String... args)
boolean	isActive(java.lang.String... args)
static DBQuery<CPNewObject>	makeQuery(DataSource ds) Make a new QUERY for this class.
CPNewObject	setBaseClass(com.aspc.dal.dbobj.DBClassAbstract value, java.lang.String... args)
CPNewObject	setCode(java.lang.String value, java.lang.String... args)
CPNewObject	setHideFg(boolean value, java.lang.String... args)
CPNewObject	setLinkText(java.lang.String value, java.lang.String... args)
CPNewObject	setModule(com.aspc.dal.dbobj.module.DBModule value, java.lang.String... args)
CPNewObject	setParams(java.lang.String value, java.lang.String... args)
CPNewObject	setScreen(com.supertracker.dal.screenobj.SDBScreen value, java.lang.String... args)
CPNewObject	setScreenType(com.aspc.dal.dbobj.misc.ScreenTypes value, java.lang.String... args)
CPNewObject	setSeq(int value, java.lang.String... args)
CPNewObject	setTarget(java.lang.String value, java.lang.String... args)
CPNewObject	setToolTip(java.lang.String value, java.lang.String... args)
CPNewObject	setWindowHeight(int value, java.lang.String... args)
CPNewObject	setWindowWidth(int 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 an entry in the control panel 'create new objects links' frame

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Defines an entry in the control panel 'create new objects links' frame

Constructor Detail

CPNewObject

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

Throws:

java.lang.Exception

getBaseClass

@CheckReturnValue
 @Nullable
public DBClassAbstract getBaseClass(java.lang.String... args)

findBaseClass

@CheckReturnValue
 @Nonnull
public final DBClassAbstract findBaseClass(java.lang.String... args)
                                                                throws NotFoundException

Base Class.

--> DBClassAbstract (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

setBaseClass

@Nonnull
public CPNewObject setBaseClass(com.aspc.dal.dbobj.DBClassAbstract 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 CPNewObject setHideFg(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isActive

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

getLinkText

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

setLinkText

@Nonnull
public CPNewObject setLinkText(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getModule

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

findModule

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

Module.

--> DBModule (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Module

Throws:

NotFoundException - DBModule was not found

setModule

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

Throws:

java.lang.Exception

getParams

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

setParams

@Nonnull
public CPNewObject setParams(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getScreen

@CheckReturnValue
 @Nullable
public SDBScreen getScreen(java.lang.String... args)

findScreen

@CheckReturnValue
 @Nonnull
public final SDBScreen findScreen(java.lang.String... args)
                                                       throws NotFoundException

Screen.

--> SDBScreen (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBScreen

Throws:

NotFoundException - SDBScreen was not found

setScreen

@Nonnull
public CPNewObject setScreen(com.supertracker.dal.screenobj.SDBScreen value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getScreenType

@CheckReturnValue
 @Nullable
public ScreenTypes getScreenType(java.lang.String... args)

findScreenType

@CheckReturnValue
 @Nonnull
public final ScreenTypes findScreenType(java.lang.String... args)
                                                             throws NotFoundException

Screen Type.

--> ScreenTypes (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

ScreenTypes

Throws:

NotFoundException - ScreenTypes was not found

setScreenType

@Nonnull
public CPNewObject setScreenType(com.aspc.dal.dbobj.misc.ScreenTypes 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 CPNewObject 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 CPNewObject 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 CPNewObject setToolTip(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getWindowHeight

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

setWindowHeight

@Nonnull
public CPNewObject setWindowHeight(int value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getWindowWidth

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

setWindowWidth

@Nonnull
public CPNewObject setWindowWidth(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

create

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

getModuleControls

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

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

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