com.aspc.cms

Class Page

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.SiteComponent

com.aspc.cms.SiteContainer

com.aspc.cms.Page

All Implemented Interfaces:

SecondaryCacheGroup

public class Page
extends SiteContainer

The page 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 The page site
static java.lang.String	DBCLASS_NAME The page site

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
Page(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
protected void	addEdit(WebClient client, HTMLPage htmlPage, HTMLDiv notUsedDiv, DBObject target)
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) Calculate the derived value for this field.
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() http://stackoverflow.com/questions/1077084/what-characters-are-allowed-in-dom-ids
HTMLComponent	extProcess(WebClient client, Site site, HTMLPage page)
HTMLComponent	extProcess(WebClient client, Site site, HTMLPage page, boolean excludingCSS)
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.
Page	findClonedPage(java.lang.String... args) cloned page.
SiteFramework	findFramework(java.lang.String... args) Deprecated.
java.lang.Object	findPluginForClassname(java.lang.String className) Generate the plugin object from the supplied class name
Site	findSite(java.lang.String... args) The site for this page.
SiteMapChangeFrequency	findSiteMapChangeFrequency(java.lang.String... args) How frequently the page is likely to change.
SitePageStatus	findStatus(java.lang.String... args) The page status.
Page	findTemplatePage(java.lang.String... args) The parent page.
CascadingStyleSheet	findV1DesktopCSS(java.lang.String... args) Deprecated.
CascadingStyleSheet	findV1MobileCSS(java.lang.String... args) mobile style sheet.
CascadingStyleSheet	findV1TabletCSS(java.lang.String... args) Deprecated.
java.lang.String	getCallOnLoad(java.lang.String... args)
Page	getClonedPage(java.lang.String... args)
java.lang.String	getConfigurationXML(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getDisplayIdentification(java.lang.String... args)
SiteFramework	getFramework(java.lang.String... args) Deprecated.
java.lang.String	getHandlebarsHelper(java.lang.String... args)
java.lang.String	getJavaScript(java.lang.String... args)
JSONObject	getJSONObject()
java.lang.String	getKeywords(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
java.util.Date	getOfflineTS(java.lang.String... args)
java.lang.String	getPageDescription(java.lang.String... args)
java.lang.String	getPageKeywords(java.lang.String... args)
java.lang.String	getPageURI(java.lang.String... args)
java.lang.String	getPath(java.lang.String... args)
java.lang.Object	getPlugin() Returns the "Plugin" for this screen.
java.util.Date	getPublishTS(java.lang.String... args)
Site	getSite(java.lang.String... args)
SiteMapChangeFrequency	getSiteMapChangeFrequency(java.lang.String... args)
double	getSiteMapPriority(java.lang.String... args)
java.lang.String	getSoeWildCardPath(java.lang.String... args)
java.lang.String	getSoeWildCardPlugin(java.lang.String... args)
java.lang.String	getSoeWildCardURL(java.lang.String... args)
SitePageStatus	getStatus(java.lang.String... args)
Page	getTemplatePage(java.lang.String... args)
java.lang.String	getTestIgnoreAreas(java.lang.String... args)
java.lang.String	getTestSetupScript(java.lang.String... args)
java.lang.String	getTitle(java.lang.String... args)
CascadingStyleSheet	getV1DesktopCSS(java.lang.String... args) Deprecated.
CascadingStyleSheet	getV1MobileCSS(java.lang.String... args)
CascadingStyleSheet	getV1TabletCSS(java.lang.String... args) Deprecated.
boolean	isDirty(java.lang.String... args)
boolean	isDoNotIndex(java.lang.String... args)
boolean	isManualLock(java.lang.String... args)
boolean	isPublished(java.lang.String... args)
boolean	isTemplate(java.lang.String... args)
boolean	isWildCardPath(java.lang.String... args)
CascadingStyleSheetMap[]	listCSS(WebClient client, Site site)
Page	setCallOnLoad(java.lang.String value, java.lang.String... args)
Page	setClonedPage(com.aspc.dal.cms.SitePage value, java.lang.String... args)
Page	setConfigurationXML(java.lang.String value, java.lang.String... args)
Page	setDirty(boolean value, java.lang.String... args)
Page	setDoNotIndex(boolean value, java.lang.String... args)
Page	setFramework(com.aspc.dal.cms.SiteFramework value, java.lang.String... args) Deprecated.
Page	setHandlebarsHelper(java.lang.String value, java.lang.String... args)
Page	setJavaScript(java.lang.String value, java.lang.String... args)
Page	setManualLock(boolean value, java.lang.String... args)
Page	setNotes(java.lang.String value, java.lang.String... args)
Page	setOfflineTS(java.util.Date value, java.lang.String... args)
Page	setPageDescription(java.lang.String value, java.lang.String... args)
Page	setPageKeywords(java.lang.String value, java.lang.String... args)
Page	setPath(java.lang.String value, java.lang.String... args)
Page	setPlugin(java.lang.String value, java.lang.String... args)
Page	setPublishTS(java.util.Date value, java.lang.String... args)
Page	setSite(com.aspc.dal.cms.Site value, java.lang.String... args)
Page	setSiteMapChangeFrequency(com.aspc.dal.cms.map.SiteMapChangeFrequency value, java.lang.String... args)
Page	setSiteMapPriority(double value, java.lang.String... args)
Page	setSoeWildCardPath(java.lang.String value, java.lang.String... args)
Page	setSoeWildCardPlugin(java.lang.String value, java.lang.String... args)
Page	setSoeWildCardURL(java.lang.String value, java.lang.String... args)
Page	setTemplate(boolean value, java.lang.String... args)
Page	setTemplatePage(com.aspc.dal.cms.SitePage value, java.lang.String... args)
Page	setTestIgnoreAreas(java.lang.String value, java.lang.String... args)
Page	setTestSetupScript(java.lang.String value, java.lang.String... args)
Page	setTitle(java.lang.String value, java.lang.String... args)
Page	setV1DesktopCSS(com.aspc.dal.style.CascadingStyleSheet value, java.lang.String... args) Deprecated.
Page	setV1MobileCSS(com.aspc.dal.style.CascadingStyleSheet value, java.lang.String... args)
Page	setV1TabletCSS(com.aspc.dal.style.CascadingStyleSheet value, java.lang.String... args) Deprecated.
void	sitePublish()
java.lang.String	toString() The description.

Methods inherited from class com.aspc.cms.SiteContainer

addContainerToDic, getLastComponentSequence, setLastComponentSequence

Methods inherited from class com.aspc.cms.SiteComponent

addEdit, canHandleNoneType, changeLinks, editHTML, extCopy, extPreValidateDelete, 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, 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

The page site

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The page site

Constructor Detail

Page

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

getCallOnLoad

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

setCallOnLoad

@Nonnull
public Page setCallOnLoad(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getClonedPage

@CheckReturnValue
 @Nullable
public Page getClonedPage(java.lang.String... args)

findClonedPage

@CheckReturnValue
 @Nonnull
public final Page findClonedPage(java.lang.String... args)
                                                      throws NotFoundException

cloned page.

--> SitePage (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SitePage

Throws:

NotFoundException - SitePage was not found

setClonedPage

@Nonnull
public Page setClonedPage(com.aspc.dal.cms.SitePage value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getConfigurationXML

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

setConfigurationXML

@Nonnull
public Page setConfigurationXML(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

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

getDisplayIdentification

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

isDoNotIndex

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

setDoNotIndex

@Nonnull
public Page setDoNotIndex(boolean value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getFramework

@Deprecated
 @CheckReturnValue
 @Nullable
public SiteFramework getFramework(java.lang.String... args)

Deprecated.

findFramework

@CheckReturnValue
 @Deprecated
 @Nonnull
public final SiteFramework findFramework(java.lang.String... args)
                                                                           throws NotFoundException

Deprecated.

The page framework ( overrides the site).

--> SiteFramework (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteFramework

Throws:

NotFoundException - SiteFramework was not found

setFramework

@Deprecated
 @Nonnull
public Page setFramework(com.aspc.dal.cms.SiteFramework value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getHandlebarsHelper

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

setHandlebarsHelper

@Nonnull
public Page setHandlebarsHelper(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isDirty

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

setDirty

@Nonnull
public Page setDirty(boolean value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

isPublished

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

isWildCardPath

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

getJavaScript

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

setJavaScript

@Nonnull
public Page setJavaScript(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getKeywords

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

isManualLock

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

setManualLock

@Nonnull
public Page setManualLock(boolean value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getNotes

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

setNotes

@Nonnull
public Page setNotes(java.lang.String value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getOfflineTS

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

setOfflineTS

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

Throws:

java.lang.Exception

getPageDescription

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

setPageDescription

@Nonnull
public Page setPageDescription(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getPageKeywords

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

setPageKeywords

@Nonnull
public Page setPageKeywords(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getPageURI

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

getPath

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

setPath

@Nonnull
public Page setPath(java.lang.String value,
                             java.lang.String... args)
                      throws java.lang.Exception

Throws:

java.lang.Exception

setPlugin

@Nonnull
public Page setPlugin(java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getPublishTS

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

setPublishTS

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

Throws:

java.lang.Exception

getSite

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

findSite

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

The site for this page.

--> Site (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Site

Throws:

NotFoundException - Site was not found

setSite

@Nonnull
public Page setSite(com.aspc.dal.cms.Site value,
                             java.lang.String... args)
                      throws java.lang.Exception

Throws:

java.lang.Exception

getSiteMapChangeFrequency

@CheckReturnValue
 @Nullable
public SiteMapChangeFrequency getSiteMapChangeFrequency(java.lang.String... args)

findSiteMapChangeFrequency

@CheckReturnValue
 @Nonnull
public final SiteMapChangeFrequency findSiteMapChangeFrequency(java.lang.String... args)
                                                                                    throws NotFoundException

How frequently the page is likely to change.

--> SiteMapChangeFrequency (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteMapChangeFrequency

Throws:

NotFoundException - SiteMapChangeFrequency was not found

setSiteMapChangeFrequency

@Nonnull
public Page setSiteMapChangeFrequency(com.aspc.dal.cms.map.SiteMapChangeFrequency value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getSiteMapPriority

@CheckReturnValue
 @Nonnegative
public double getSiteMapPriority(java.lang.String... args)

setSiteMapPriority

@Nonnull
public Page setSiteMapPriority(double value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getSoeWildCardPath

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

setSoeWildCardPath

@Nonnull
public Page setSoeWildCardPath(@MatchesPattern(value="[a-z0-9_\\-][/\\?&A-Za-z0-9=_\\-\\.\\,]+\\*")
                                        java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getSoeWildCardPlugin

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

setSoeWildCardPlugin

@Nonnull
public Page setSoeWildCardPlugin(@MatchesPattern(value="([a-zA-Z_$][a-zA-Z0-9_$]*\\.)*[a-zA-Z_$][a-zA-Z0-9_$]*")
                                          java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSoeWildCardURL

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

setSoeWildCardURL

@Nonnull
public Page setSoeWildCardURL(@MatchesPattern(value="(http://|https://|/)+.*")
                                       java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

@CheckReturnValue
 @Nullable
public SitePageStatus getStatus(java.lang.String... args)

findStatus

@CheckReturnValue
 @Nonnull
public final SitePageStatus findStatus(java.lang.String... args)
                                                            throws NotFoundException

The page status.

--> SitePageStatus (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

SitePageStatus

Throws:

NotFoundException - SitePageStatus was not found

isTemplate

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

setTemplate

@Nonnull
public Page setTemplate(boolean value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getTemplatePage

@CheckReturnValue
 @Nullable
public Page getTemplatePage(java.lang.String... args)

findTemplatePage

@CheckReturnValue
 @Nonnull
public final Page findTemplatePage(java.lang.String... args)
                                                        throws NotFoundException

The parent page.

--> SitePage (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SitePage

Throws:

NotFoundException - SitePage was not found

setTemplatePage

@Nonnull
public Page setTemplatePage(com.aspc.dal.cms.SitePage value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getTestIgnoreAreas

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

setTestIgnoreAreas

@Nonnull
public Page setTestIgnoreAreas(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getTestSetupScript

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

setTestSetupScript

@Nonnull
public Page setTestSetupScript(java.lang.String 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 Page setTitle(java.lang.String value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getV1DesktopCSS

@Deprecated
 @CheckReturnValue
 @Nullable
public CascadingStyleSheet getV1DesktopCSS(java.lang.String... args)

Deprecated.

findV1DesktopCSS

@CheckReturnValue
 @Deprecated
 @Nonnull
public final CascadingStyleSheet findV1DesktopCSS(java.lang.String... args)
                                                                                    throws NotFoundException

Deprecated.

desktop style sheet.

--> CascadingStyleSheet (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Cascading Style Sheet

Throws:

NotFoundException - CascadingStyleSheet was not found

setV1DesktopCSS

@Deprecated
 @Nonnull
public Page setV1DesktopCSS(com.aspc.dal.style.CascadingStyleSheet value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getV1MobileCSS

@CheckReturnValue
 @Nullable
public CascadingStyleSheet getV1MobileCSS(java.lang.String... args)

findV1MobileCSS

@CheckReturnValue
 @Nonnull
public final CascadingStyleSheet findV1MobileCSS(java.lang.String... args)
                                                                      throws NotFoundException

mobile style sheet.

--> CascadingStyleSheet (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Cascading Style Sheet

Throws:

NotFoundException - CascadingStyleSheet was not found

setV1MobileCSS

@Nonnull
public Page setV1MobileCSS(com.aspc.dal.style.CascadingStyleSheet value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getV1TabletCSS

@Deprecated
 @CheckReturnValue
 @Nullable
public CascadingStyleSheet getV1TabletCSS(java.lang.String... args)

Deprecated.

findV1TabletCSS

@CheckReturnValue
 @Deprecated
 @Nonnull
public final CascadingStyleSheet findV1TabletCSS(java.lang.String... args)
                                                                                   throws NotFoundException

Deprecated.

tablet style sheet.

--> CascadingStyleSheet (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Cascading Style Sheet

Throws:

NotFoundException - CascadingStyleSheet was not found

setV1TabletCSS

@Deprecated
 @Nonnull
public Page setV1TabletCSS(com.aspc.dal.style.CascadingStyleSheet value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

sitePublish

public void sitePublish()
                 throws java.lang.Exception

Throws:

java.lang.Exception

extPreValidate

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

http://stackoverflow.com/questions/1077084/what-characters-are-allowed-in-dom-ids

Overrides:

extPreValidate in class SiteComponent

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 SiteComponent

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 SiteComponent

Parameters:

list - The validation list

Throws:

java.lang.Exception - A serious problem

addEdit

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

Overrides:

addEdit in class SiteComponent

Throws:

java.lang.Exception

listCSS

public CascadingStyleSheetMap[] listCSS(WebClient client,
                                        Site site)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

extProcess

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

Overrides:

extProcess in class SiteContainer

Parameters:

client - the client to use

site -

page -

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

extProcess

public HTMLComponent extProcess(@Nonnull
                                WebClient client,
                                Site site,
                                HTMLPage page,
                                boolean excludingCSS)
                         throws java.lang.Exception

Throws:

java.lang.Exception

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 SiteComponent

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

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 SiteContainer

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

toString

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

Description copied from class: DBObject

The description.

Overrides:

toString in class DBObject

Returns:

The description

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.

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 SiteComponent

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

getJSONObject

public JSONObject getJSONObject()

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

getPlugin

public java.lang.Object getPlugin()
                           throws java.lang.Exception

Returns the "Plugin" for this screen. A plugin may implement many screen controlling interfaces which will effect the presentation logic of this screen.

Returns:

the value

Throws:

java.lang.Exception - a serious problem

findPluginForClassname

public java.lang.Object findPluginForClassname(java.lang.String className)
                                        throws java.lang.Exception

Generate the plugin object from the supplied class name

Parameters:

className - the name of the class to initiate

Returns:

the value

Throws:

java.lang.Exception - a serious problem