com.aspc.cms.component

Class FormComponent

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.SiteComponent

com.aspc.cms.component.FormComponent

All Implemented Interfaces:

SecondaryCacheGroup

public class FormComponent
extends SiteComponent

Form component.

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

Since:

15 Mar 2013

Author:

Liam

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 Form component
static java.lang.String	DBCLASS_NAME Form component

Fields inherited from class com.aspc.cms.SiteComponent

SNAP2MAP

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) OVERRIDE This method to return a derived global key.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
HTMLComponent	extProcess(WebClient client, Site site, HTMLPage htmlPage)
DBClass	findDbClass(java.lang.String... args) The class for this form.
DBModule	findModule(java.lang.String... args) The module.
SDBDataEntryScreen	findScreen(java.lang.String... args) The raw screen.
DBClass	getDbClass(java.lang.String... args)
DBModule	getModule(java.lang.String... args)
SDBDataEntryScreen	getScreen(java.lang.String... args)
FormComponent	setDbClass(com.aspc.dal.dbobj.DBClass value, java.lang.String... args)
FormComponent	setModule(com.aspc.dal.dbobj.module.DBModule value, java.lang.String... args)
FormComponent	setScreen(com.supertracker.dal.screenobj.SDBDataEntryScreen value, java.lang.String... args)

Methods inherited from class com.aspc.cms.SiteComponent

addEdit, addEdit, canHandleNoneType, changeLinks, editHTML, extCopy, extPreDeleteRecord, extPreValidate, extPreValidateDelete, extValidateDelete, extValidateField, extValidateRecord, findContainer, findIcon, findKey, findOwnedBySite, findVisibilityDesktop, findVisibilityMobile, findVisibilityTablet, getAccessibilityWarningCount, getAccessibilityWarningResult, getComponentPath, getContainer, getCreatedTS, getDefaultEncoding, getDerivedStyleClass, getDescendant, getDisplayPath, getDisplayTitle, getDisplayType, getDisplayXPath, getHandlebarsData, getHandlebarsHelpers, getIcon, getIconPath, getKey, getName, getOwnedBySite, getPage, getResult, getSequence, getSnap2Id, getStyleClass, getStyleClassVariable, getTargetWindow, getVisibilityDesktop, getVisibilityMobile, getVisibilityTablet, hasAttributes, isFinalFg, isLocked, isRelevantComponent, makeClone, makeDIV, makeQuery, makeSane, parseText, process, setAccessibilityWarningCount, setAccessibilityWarningResult, setContainer, setCreatedTS, setFinalFg, setHasAttributes, setId, setKey, setName, setSequence, setSnap2Id, setStyleClass, setStyleClassVariable, setVisibilityDesktop, setVisibilityMobile, setVisibilityTablet, shouldShow

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, extDelete, extDeleteRecord, extFixUp, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, 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

Form component

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Form component

Constructor Detail

FormComponent

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

getDbClass

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

findDbClass

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

The class for this form.

--> DBClass (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClass

Throws:

NotFoundException - DBClass was not found

setDbClass

@Nonnull
public FormComponent setDbClass(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

The module.

--> DBModule (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Module

Throws:

NotFoundException - DBModule was not found

setModule

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

Throws:

java.lang.Exception

getScreen

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

findScreen

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

The raw screen.

--> SDBDataEntryScreen (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SDBDataEntryScreen

Throws:

NotFoundException - SDBDataEntryScreen was not found

setScreen

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

Throws:

java.lang.Exception

extPreSaveRecord

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

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class SiteComponent

Throws:

java.lang.Exception - A Serious problem

extGetDerivedGlobalKey

@CheckReturnValue
 @Nullable
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)
                                                                 throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method to return a derived global key. This method is only checked if the field is marked as being linked.

Overrides:

extGetDerivedGlobalKey in class SiteComponent

Parameters:

field - The field that is being changed

params - The extra parameters

Returns:

The Global key

Throws:

java.lang.Exception - A serious problem. In general validation is done later.

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class SiteComponent

Parameters:

field - The field to get

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

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

extProcess

public HTMLComponent extProcess(WebClient client,
                                Site site,
                                HTMLPage htmlPage)
                         throws java.lang.Exception

Specified by:

extProcess in class SiteComponent

Throws:

java.lang.Exception