com.aspc.DBObj.Help

Class DBDynamicScreenHelpItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Help.DBHelpItem

com.aspc.DBObj.Help.DBDynamicScreenHelpItem

All Implemented Interfaces:

SecondaryCacheGroup

public class DBDynamicScreenHelpItem
extends DBHelpItem

Dynamically generated help based on information contained internally within a screen.

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

Since:

June 20, 2007, 11:15 PM

Author:

nabhilash

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 Dynamically generated help based on information contained internally within a screen
static java.lang.String	DBCLASS_NAME Dynamically generated help based on information contained internally within a screen

Fields inherited from class com.aspc.DBObj.Help.DBHelpItem

ROOT_HELP_ITEM_GKEY

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
DBClass	findClassId(java.lang.String... args) Class to generate help for.
DBModule	findModule(java.lang.String... args) link to DBModule.
SDBScreen	findScreen(java.lang.String... args) link to SDBScreen.
DBClass	getClassId(java.lang.String... args)
SDBComponent[]	getComponents(SDBContext context, SDBContainer comp) Retrieve the list of components sorted based on their normal appearance on the screen
DBModule	getModule(java.lang.String... args)
SDBScreen	getScreen(java.lang.String... args)
DBDynamicScreenHelpItem	setClassId(com.aspc.dal.dbobj.DBClass value, java.lang.String... args)
DBDynamicScreenHelpItem	setModule(com.aspc.dal.dbobj.module.DBModule value, java.lang.String... args)
DBDynamicScreenHelpItem	setScreen(com.supertracker.dal.screenobj.SDBScreen value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.Help.DBHelpItem

buildHTMLAnchor, create, displayName, eventFieldUpdated, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extFixUp, extIsMandatory, extIsOnChange, extSetValue, extValidateField, findContentAuthor, findHelpFile, findKey, findParentId, getContentAuthor, getDisplayHTML, getDisplayHTMLPath, getDisplayShortText, getHelpFile, getHtmlText, getID, getModifiedTS, getParentFolder, getParentId, getPath, getPermittedLayers, getPlainText, getSection, getSeq, getTitle, hasCreateAccess, hasDeleteAccess, hasFullAccess, hasModifyAccess, hasReadAccess, makeQuery, setContentAuthor, setHelpFile, setHtmlText, setID, setModifiedTS, setParentId, setPermittedLayers, setPlainText, setSeq, setShowSectionsAsHeirachy, setTitle, showSectionsAsHeirachy

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, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, 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

Dynamically generated help based on information contained internally within a screen

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Dynamically generated help based on information contained internally within a screen

Constructor Detail

DBDynamicScreenHelpItem

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

getClassId

@CheckReturnValue
 @Nullable
public DBClass getClassId(java.lang.String... args)

findClassId

@CheckReturnValue
 @Nonnull
public final DBClass findClassId(java.lang.String... args)
                                                      throws NotFoundException

Class to generate help for.

--> DBClass (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClass

Throws:

NotFoundException - DBClass was not found

setClassId

@Nonnull
public DBDynamicScreenHelpItem setClassId(com.aspc.dal.dbobj.DBClass 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

link to DBModule.

--> DBModule (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Module

Throws:

NotFoundException - DBModule was not found

setModule

@Nonnull
public DBDynamicScreenHelpItem setModule(com.aspc.dal.dbobj.module.DBModule 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

link to SDBScreen.

--> SDBScreen (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBScreen

Throws:

NotFoundException - SDBScreen was not found

setScreen

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

Throws:

java.lang.Exception

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 DBHelpItem

Parameters:

field - The field to get

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

Returns:

The derived value.

Throws:

java.lang.Exception - A serious problem

getComponents

public SDBComponent[] getComponents(SDBContext context,
                                    SDBContainer comp)
                             throws java.lang.Exception

Retrieve the list of components sorted based on their normal appearance on the screen

Parameters:

context - The screen context

comp - the container that contains the sub components

Returns:

The list of sub components

Throws:

java.lang.Exception - A serious problem