com.aspc.cms

Class SiteComponent

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.SiteComponent

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

ArticleComponent, BreadCrumbComponent, FeedComponent, FormComponent, FrameComponent, HtmlActiveComponent, HtmlTextComponent, MenuComponent, SiteContainer

public abstract class SiteComponent
extends DBObject

A component for the site.

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

Since:

4 December 2003

Author:

Nigel Leck

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 A component for the site
static java.lang.String	DBCLASS_NAME A component for the site
static java.lang.String	SNAP2MAP

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addEdit(WebClient client, HTMLPage page, HTMLComponent div, DBObject target, java.lang.String componentId)
protected void	addEdit(WebClient client, HTMLPage page, HTMLDiv div, DBObject target)
protected boolean	canHandleNoneType(java.lang.String html) can we handle the none type content
void	changeLinks(java.lang.String aFrom, java.lang.String aTo)
static java.lang.String	editHTML(WebClient client, java.lang.String rawHTML)
protected void	extCopy(DBObject target) Additional functionality when an object is copied.
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	extPreDeleteRecord() OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from the database.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected void	extPreValidateDelete() OVERRIDE To add functionality to before validation is called.
abstract HTMLComponent	extProcess(WebClient client, Site site, HTMLPage page)
protected void	extValidateDelete(ValidationList list) Extend this method to add validation to a record then deleted.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
SiteContainer	findContainer(java.lang.String... args) The page for this section.
DBFile	findIcon(java.lang.String... args) The icon for this component.
static SiteComponent	findKey(DataSource ds, int key) Find the target for this class by the primary key
Site	findOwnedBySite(java.lang.String... args) The site that owns this component.
SiteComponentVisibility	findVisibilityDesktop(java.lang.String... args) The visibility for a desktop.
SiteComponentVisibility	findVisibilityMobile(java.lang.String... args) The visibility for a mobile.
SiteComponentVisibility	findVisibilityTablet(java.lang.String... args) The visibility for a tablet.
int	getAccessibilityWarningCount(java.lang.String... args)
java.lang.String	getAccessibilityWarningResult(java.lang.String... args)
java.lang.String	getComponentPath(java.lang.String... args)
SiteContainer	getContainer(java.lang.String... args)
java.util.Date	getCreatedTS(java.lang.String... args)
protected java.lang.String	getDefaultEncoding()
java.lang.String	getDerivedStyleClass(java.lang.String... args)
java.lang.String	getDescendant(java.lang.String... args)
java.lang.String	getDisplayPath(java.lang.String... args)
java.lang.String	getDisplayTitle(java.lang.String... args)
java.lang.String	getDisplayType(java.lang.String... args)
java.lang.String	getDisplayXPath(java.lang.String... args)
java.lang.String	getHandlebarsData(java.lang.String... args)
protected java.util.HashMap<java.lang.String,java.lang.String>	getHandlebarsHelpers(WebClient client)
DBFile	getIcon(java.lang.String... args)
java.lang.String	getIconPath(java.lang.String... args)
int	getKey(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
Site	getOwnedBySite(java.lang.String... args)
Page	getPage() get the page container of this component
java.lang.String	getResult(java.lang.String... args)
int	getSequence(java.lang.String... args)
java.lang.String	getSnap2Id(java.lang.String... args)
java.lang.String	getStyleClass(java.lang.String... args)
java.lang.String	getStyleClassVariable(java.lang.String... args)
java.lang.String	getTargetWindow(java.lang.String... args)
SiteComponentVisibility	getVisibilityDesktop(java.lang.String... args)
SiteComponentVisibility	getVisibilityMobile(java.lang.String... args)
SiteComponentVisibility	getVisibilityTablet(java.lang.String... args)
boolean	hasAttributes(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
boolean	isLocked(java.lang.String... args)
boolean	isRelevantComponent(java.lang.String... args)
static DBObject	makeClone(MutableDataSource mds, DBObject srcObj, java.util.HashMap<java.lang.Long,DBObject> clonedMap)
protected HTMLDiv	makeDIV(HTMLPage page)
static DBQuery<SiteComponent>	makeQuery(DataSource ds) Make a new QUERY for this class.
static void	makeSane(DBObject clonedObj, java.util.HashMap<java.lang.Long,DBObject> clonedMap)
static java.lang.String	parseText(java.lang.String text, Site site)
HTMLComponent	process(WebClient client, Site site, HTMLPage page)
SiteComponent	setAccessibilityWarningCount(int value, java.lang.String... args)
SiteComponent	setAccessibilityWarningResult(java.lang.String value, java.lang.String... args)
SiteComponent	setContainer(com.aspc.dal.cms.SiteContainer value, java.lang.String... args)
SiteComponent	setCreatedTS(java.util.Date value, java.lang.String... args)
SiteComponent	setFinalFg(boolean value, java.lang.String... args)
SiteComponent	setHasAttributes(boolean value, java.lang.String... args)
protected java.lang.String[]	setId(HTMLPage page, java.lang.String html) set/find id for the given html
SiteComponent	setKey(int value, java.lang.String... args)
SiteComponent	setName(java.lang.String value, java.lang.String... args)
SiteComponent	setSequence(int value, java.lang.String... args)
SiteComponent	setSnap2Id(java.lang.String value, java.lang.String... args)
SiteComponent	setStyleClass(java.lang.String value, java.lang.String... args)
SiteComponent	setStyleClassVariable(java.lang.String value, java.lang.String... args)
SiteComponent	setVisibilityDesktop(com.aspc.dal.cms.SiteComponentVisibility value, java.lang.String... args)
SiteComponent	setVisibilityMobile(com.aspc.dal.cms.SiteComponentVisibility value, java.lang.String... args)
SiteComponent	setVisibilityTablet(com.aspc.dal.cms.SiteComponentVisibility value, java.lang.String... args)
boolean	shouldShow(ClientBrowser browser) Should we show this component or not ?

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

A component for the site

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A component for the site

SNAP2MAP

public static final java.lang.String SNAP2MAP

See Also:

Constant Field Values

Constructor Detail

SiteComponent

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

getKey

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

setKey

@Nonnull
public SiteComponent setKey(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getAccessibilityWarningCount

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

setAccessibilityWarningCount

@Nonnull
public SiteComponent setAccessibilityWarningCount(int value,
                                                           java.lang.String... args)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getAccessibilityWarningResult

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

setAccessibilityWarningResult

@Nonnull
public SiteComponent setAccessibilityWarningResult(java.lang.String value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getComponentPath

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

getContainer

@CheckReturnValue
 @Nullable
public SiteContainer getContainer(java.lang.String... args)

findContainer

@CheckReturnValue
 @Nonnull
public final SiteContainer findContainer(java.lang.String... args)
                                                              throws NotFoundException

The page for this section.

--> SiteContainer (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Division

Throws:

NotFoundException - SiteContainer was not found

setContainer

@Nonnull
public SiteComponent setContainer(com.aspc.dal.cms.SiteContainer value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getCreatedTS

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

setCreatedTS

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

Throws:

java.lang.Exception

getDerivedStyleClass

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

getDescendant

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

getDisplayPath

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

getDisplayTitle

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

getDisplayType

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

getDisplayXPath

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

isFinalFg

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

setFinalFg

@Nonnull
public SiteComponent setFinalFg(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getHandlebarsData

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

hasAttributes

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

setHasAttributes

@Nonnull
public SiteComponent setHasAttributes(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

The icon for this component.

--> DBFile (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

getIconPath

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

isLocked

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

getName

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

setName

@Nonnull
public SiteComponent setName(@MatchesPattern(value="^[A-Za-z]+[A-Za-z0-9_:\\.-]*")
                                      java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getOwnedBySite

@CheckReturnValue
 @Nullable
public Site getOwnedBySite(java.lang.String... args)

findOwnedBySite

@CheckReturnValue
 @Nonnull
public final Site findOwnedBySite(java.lang.String... args)
                                                       throws NotFoundException

The site that owns this component.

--> Site (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Site

Throws:

NotFoundException - Site was not found

isRelevantComponent

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

getResult

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

getSequence

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

setSequence

@Nonnull
public SiteComponent setSequence(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSnap2Id

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

setSnap2Id

@Nonnull
public SiteComponent setSnap2Id(@MatchesPattern(value="^[A-Za-z][A-Za-z0-9_:\\\\.-]+")
                                         java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getStyleClass

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

setStyleClass

@Nonnull
public SiteComponent setStyleClass(@MatchesPattern(value="(-?[_a-zA-Z]+[_a-zA-Z0-9\\-]*| )*")
                                            java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getStyleClassVariable

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

setStyleClassVariable

@Nonnull
public SiteComponent setStyleClassVariable(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getTargetWindow

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

getVisibilityDesktop

@CheckReturnValue
 @Nullable
public SiteComponentVisibility getVisibilityDesktop(java.lang.String... args)

findVisibilityDesktop

@CheckReturnValue
 @Nonnull
public final SiteComponentVisibility findVisibilityDesktop(java.lang.String... args)
                                                                                throws NotFoundException

The visibility for a desktop.

--> SiteComponentVisibility (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteComponentVisibility

Throws:

NotFoundException - SiteComponentVisibility was not found

setVisibilityDesktop

@Nonnull
public SiteComponent setVisibilityDesktop(com.aspc.dal.cms.SiteComponentVisibility value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getVisibilityMobile

@CheckReturnValue
 @Nullable
public SiteComponentVisibility getVisibilityMobile(java.lang.String... args)

findVisibilityMobile

@CheckReturnValue
 @Nonnull
public final SiteComponentVisibility findVisibilityMobile(java.lang.String... args)
                                                                               throws NotFoundException

The visibility for a mobile.

--> SiteComponentVisibility (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteComponentVisibility

Throws:

NotFoundException - SiteComponentVisibility was not found

setVisibilityMobile

@Nonnull
public SiteComponent setVisibilityMobile(com.aspc.dal.cms.SiteComponentVisibility value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getVisibilityTablet

@CheckReturnValue
 @Nullable
public SiteComponentVisibility getVisibilityTablet(java.lang.String... args)

findVisibilityTablet

@CheckReturnValue
 @Nonnull
public final SiteComponentVisibility findVisibilityTablet(java.lang.String... args)
                                                                               throws NotFoundException

The visibility for a tablet.

--> SiteComponentVisibility (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteComponentVisibility

Throws:

NotFoundException - SiteComponentVisibility was not found

setVisibilityTablet

@Nonnull
public SiteComponent setVisibilityTablet(com.aspc.dal.cms.SiteComponentVisibility value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

makeQuery

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

parseText

public static java.lang.String parseText(java.lang.String text,
                                         Site site)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getHandlebarsHelpers

protected java.util.HashMap<java.lang.String,java.lang.String> getHandlebarsHelpers(WebClient client)
                                                                             throws java.lang.Exception

Throws:

java.lang.Exception

shouldShow

public boolean shouldShow(ClientBrowser browser)
                   throws java.lang.Exception

Should we show this component or not ?

Parameters:

browser - The browser

Returns:

true if we should show.

Throws:

java.lang.Exception - a serious problem.

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 DBObject

Throws:

java.lang.Exception - A Serious problem

extPreDeleteRecord

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

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from 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:

extPreDeleteRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

extValidateDelete

@OverridingMethodsMustInvokeSuper
protected void extValidateDelete(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Description copied from class: DBObject

Extend this method to add validation to a record then deleted.

Overrides:

extValidateDelete in class DBObject

Parameters:

list - The validation list

Throws:

java.lang.Exception - A serious problem

canHandleNoneType

protected boolean canHandleNoneType(java.lang.String html)

can we handle the none type content

Parameters:

html -

Returns:

the value

setId

protected java.lang.String[] setId(HTMLPage page,
                                   java.lang.String html)

set/find id for the given html

Parameters:

page -

html -

Returns:

String array with 2 elements, first one is the id, second one is the fixed html

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Description copied from class: DBObject

Performs additional validations on this record. OVERRIDE this method to add additional validations to a record.
The MutableDataSource is in READONLY mode at this stage.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extPreValidateDelete

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

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS FOR DELETED RECORDS.

Overrides:

extPreValidateDelete in class DBObject

Throws:

java.lang.Exception - a serious problem

getPage

public Page getPage()
             throws java.lang.Exception

get the page container of this component

Returns:

page or null

Throws:

java.lang.Exception - a serious problem.

extPreValidate

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

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

makeDIV

protected HTMLDiv makeDIV(HTMLPage page)
                   throws java.lang.Exception

Throws:

java.lang.Exception

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 DBObject

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 DBObject

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

changeLinks

public void changeLinks(java.lang.String aFrom,
                        java.lang.String aTo)
                 throws java.lang.Exception

Throws:

java.lang.Exception

makeSane

public static void makeSane(DBObject clonedObj,
                            java.util.HashMap<java.lang.Long,DBObject> clonedMap)
                     throws java.lang.Exception

Throws:

java.lang.Exception

makeClone

public static DBObject makeClone(MutableDataSource mds,
                                 DBObject srcObj,
                                 java.util.HashMap<java.lang.Long,DBObject> clonedMap)
                          throws java.lang.Exception

Throws:

java.lang.Exception

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Description copied from class: DBObject

Additional functionality when an object is copied.

Overrides:

extCopy in class DBObject

Parameters:

target - the target object

Throws:

java.lang.Exception - A serious problem

extValidateField

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

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

editHTML

public static java.lang.String editHTML(WebClient client,
                                        java.lang.String rawHTML)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

addEdit

protected void addEdit(WebClient client,
                       HTMLPage page,
                       HTMLDiv div,
                       DBObject target)
                throws java.lang.Exception

Throws:

java.lang.Exception

addEdit

protected void addEdit(WebClient client,
                       HTMLPage page,
                       HTMLComponent div,
                       DBObject target,
                       java.lang.String componentId)
                throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultEncoding

protected java.lang.String getDefaultEncoding()

process

public final HTMLComponent process(WebClient client,
                                   Site site,
                                   HTMLPage page)
                            throws java.lang.Exception

Throws:

java.lang.Exception

extProcess

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

Throws:

java.lang.Exception