com.aspc.DBObj.Help

Class DBHelpItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Help.DBHelpItem

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBDynamicScreenHelpItem

public class DBHelpItem
extends DBObject

Provides the help system structure.

Notes

core

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

Since:

June 1, 2001, 11:51 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 Provides the help system structure.
static java.lang.String	DBCLASS_NAME Provides the help system structure.
static GlobalKey	ROOT_HELP_ITEM_GKEY The root HELP ITEM

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildHTMLAnchor(DBHelpItem helpItem, java.lang.String target, FldParams params)
static DBHelpItem	create(MutableDataSource mds) Make a new instance of this class.
java.lang.String	displayName() The human display name of this object.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) Additional business logic when a field is updated.
protected void	extCheckDeleteAccess() Additional access checking for delete access of this object.
protected void	extCheckModifyAccess() Additional access checking for write access of this object.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access for a field of this object.
protected void	extCheckReadAccess() Additional access checking for read access of this object.
protected void	extFixUp() The extended fix up routine
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) We prevent some values from being set by a user.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
Person	findContentAuthor(java.lang.String... args) Content Author.
DBFile	findHelpFile(java.lang.String... args) Help File.
static DBHelpItem	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBHelpItem	findParentId(java.lang.String... args) Parent Id.
Person	getContentAuthor(java.lang.String... args)
java.lang.String	getDisplayHTML(java.lang.String... args)
java.lang.String	getDisplayHTMLPath(java.lang.String... args)
java.lang.String	getDisplayShortText(java.lang.String... args)
DBFile	getHelpFile(java.lang.String... args)
java.lang.String	getHtmlText(java.lang.String... args)
int	getID(java.lang.String... args)
java.util.Date	getModifiedTS(java.lang.String... args)
DBHelpItem	getParentFolder() The parent folder of this help item.
DBHelpItem	getParentId(java.lang.String... args)
java.lang.String	getPath(java.lang.String... args)
java.lang.String	getPermittedLayers(java.lang.String... args)
java.lang.String	getPlainText(java.lang.String... args)
protected java.lang.String	getSection(boolean category, FldParams params) Automatically generate section string.
int	getSeq(java.lang.String... args)
java.lang.String	getTitle(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	hasReadAccess(java.lang.String... args)
static DBQuery<DBHelpItem>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBHelpItem	setContentAuthor(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
DBHelpItem	setHelpFile(com.aspc.dal.file.DBFile value, java.lang.String... args)
DBHelpItem	setHtmlText(java.lang.String value, java.lang.String... args)
DBHelpItem	setID(int value, java.lang.String... args)
DBHelpItem	setModifiedTS(java.util.Date value, java.lang.String... args)
DBHelpItem	setParentId(com.aspc.dal.dbobj.help.DBHelpItem value, java.lang.String... args)
DBHelpItem	setPermittedLayers(java.lang.String value, java.lang.String... args)
DBHelpItem	setPlainText(java.lang.String value, java.lang.String... args)
DBHelpItem	setSeq(int value, java.lang.String... args)
DBHelpItem	setShowSectionsAsHeirachy(boolean value, java.lang.String... args)
DBHelpItem	setTitle(java.lang.String value, java.lang.String... args)
boolean	showSectionsAsHeirachy(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, 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

ROOT_HELP_ITEM_GKEY

public static final GlobalKey ROOT_HELP_ITEM_GKEY

The root HELP ITEM

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Provides the help system structure.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Provides the help system structure.

Constructor Detail

DBHelpItem

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

getID

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

setID

@Nonnull
public DBHelpItem setID(int value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getContentAuthor

@CheckReturnValue
 @Nullable
public Person getContentAuthor(java.lang.String... args)

findContentAuthor

@CheckReturnValue
 @Nonnull
public final Person findContentAuthor(java.lang.String... args)
                                                           throws NotFoundException

Content Author.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setContentAuthor

@Nonnull
public DBHelpItem setContentAuthor(com.aspc.dal.dbobj.contact.Person value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayHTML

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

getDisplayHTMLPath

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

getDisplayShortText

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplayShortText(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)

getHelpFile

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

findHelpFile

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

Help File.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Help Item

Throws:

NotFoundException - DBFile was not found

setHelpFile

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

Throws:

java.lang.Exception

getHtmlText

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

setHtmlText

@Nonnull
public DBHelpItem setHtmlText(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getModifiedTS

@CheckReturnValue
 @Nullable
public java.util.Date getModifiedTS(java.lang.String... args)

setModifiedTS

@Nonnull
public DBHelpItem setModifiedTS(java.util.Date value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getParentId

@CheckReturnValue
 @Nullable
public DBHelpItem getParentId(java.lang.String... args)

findParentId

@CheckReturnValue
 @Nonnull
public final DBHelpItem findParentId(java.lang.String... args)
                                                          throws NotFoundException

Parent Id.

--> DBHelpItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

child item

Throws:

NotFoundException - DBHelpItem was not found

setParentId

@Nonnull
public DBHelpItem setParentId(com.aspc.dal.dbobj.help.DBHelpItem value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getPath

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

getPermittedLayers

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

setPermittedLayers

@Nonnull
public DBHelpItem setPermittedLayers(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getPlainText

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

setPlainText

@Nonnull
public DBHelpItem setPlainText(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 DBHelpItem setSeq(int value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

showSectionsAsHeirachy

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

setShowSectionsAsHeirachy

@Nonnull
public DBHelpItem setShowSectionsAsHeirachy(boolean value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getTitle

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

setTitle

@Nonnull
public DBHelpItem setTitle(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBHelpItem 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<DBHelpItem> 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 DBHelpItem findKey(@Nonnull
                                                             DataSource ds,
                                                             int 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

extFixUp

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

Description copied from class: DBObject

The extended fix up routine

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

displayName

@CheckReturnValue
 @Nonnull
public java.lang.String displayName()

The human display name of this object.

Overrides:

displayName in class DBObject

Returns:

the display name

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

extValidateField

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

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

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 derived value.

Throws:

java.lang.Exception - A serious problem

extCheckDeleteAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckDeleteAccess()
                                                               throws DBAccessException

Description copied from class: DBObject

Additional access checking for delete access of this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to delete

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess()
                                                               throws DBAccessException

Description copied from class: DBObject

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Throws:

DBAccessException - No access to modify

extCheckReadAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckReadAccess()
                                                             throws DBAccessException

Description copied from class: DBObject

Additional access checking for read access of this object.

Overrides:

extCheckReadAccess in class DBObject

Throws:

DBAccessException - No access to read

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(DBField field)
                                                               throws DBAccessException

Description copied from class: DBObject

Additional access checking for write access for a field of this object.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - Can we change this field ?

Throws:

DBAccessException - No access to change

getSection

protected java.lang.String getSection(boolean category,
                                      FldParams params)
                               throws java.lang.Exception

Automatically generate section string.

Parameters:

category - boolean value for category

params - The parameters for this field

Returns:

the section list

Throws:

java.lang.Exception - A serious problem

buildHTMLAnchor

public java.lang.String buildHTMLAnchor(DBHelpItem helpItem,
                                        java.lang.String target,
                                        FldParams params)
                                 throws java.lang.Exception

Parameters:

helpItem - the item

target - the target

params - the parameters

Returns:

the anchor

Throws:

java.lang.Exception - a serious problem

getParentFolder

public DBHelpItem getParentFolder()

The parent folder of this help item.

Returns:

The item.

extSetValue

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

We prevent some values from being set by a user.

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

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

OVERRIDE This method to specify that when a field is updated it will affect other fields.

Overrides:

extIsOnChange in class DBObject

Parameters:

field - The field to check

Returns:

eventFieldUpdated

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

Additional business logic when a field is updated.

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

See Also:

DBObject.eventFieldUpdated( DBField, Object, GlobalKey, FldParams)