com.aspc.cms

Class Site

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.SiteTemplate

com.aspc.cms.Site

All Implemented Interfaces:

AdjustTransactionReason, SecondaryCacheGroup

public class Site
extends SiteTemplate
implements AdjustTransactionReason

The site definition.

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 java.lang.String	ATTRIBUTE_SITE_CLONE
static GlobalId	DBCLASS_GID The site definition
static java.lang.String	DBCLASS_NAME The site definition

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addStyle(WebClient client, HTMLPage page, CascadingStyleSheet css, java.lang.String media)
void	addStyle(WebClient client, HTMLPage page, CascadingStyleSheet css, java.lang.String media, java.util.Date publishedTS)
java.lang.String	adjustReason(java.lang.String reason, boolean first) adjust the reason
Site	cleanSite() Clean the site ( use archive if needed)
static Site	create(MutableDataSource mds) Make a new instance of this class.
Page	defaultPage()
Page	errorPage()
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) OVERRIDE This method to be notified when a field changes.
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	extPostSaveRecord(long transNr) OVERRIDE this method to add functionality to stSoftware AFTER saving the record to 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	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.
DBFile	findAppleTouchIcon(java.lang.String... args) apple touch icon.
DBFile	findAppleTouchIconPrecomposed(java.lang.String... args) apple touch icon precomposed.
FeedComponent	findArticleFeedComponent(java.lang.String... args) The article feed component.
Site	findClonedSite(java.lang.String... args) cloned site.
Page	findDefaultPage(java.lang.String... args) The default page.
Page	findErrorPage(java.lang.String... args) The error page.
DBFile	findFavicon(java.lang.String... args) A favicon /ˈfævɪkɒn/ (short for Favorite icon), also known as a shortcut icon, Web site icon, URL icon, or bookmark icon,.
SiteFramework	findFramework(java.lang.String... args) Deprecated.
static Site	findKey(DataSource ds, int key) Find the target for this class by the primary key
WebAppManifestDisplay	findManifestDisplay(java.lang.String... args) Defines the developer's preferred display mode for the web application.
Page	findMissingPage(java.lang.String... args) The missing page.
Page	findPage(boolean publishedOnly, java.lang.String pagePath, java.lang.String queryString, ClientBrowser browser) get the page
SiteRevision	findPublshedSiteRevision(java.lang.String... args) The version of the site that is currently published.
SiteStatus	findStatus(java.lang.String... args) Site Status.
DBFile	findStatusIcon(java.lang.String... args) Statis Icon DBFile.
SiteFeedParser	findV2ArticleParser(java.lang.String... args) Deprecated.
DBFile	getAppleTouchIcon(java.lang.String... args)
DBFile	getAppleTouchIconPrecomposed(java.lang.String... args)
java.util.Date	getArchiveTS(java.lang.String... args)
FeedComponent	getArticleFeedComponent(java.lang.String... args)
java.util.Date	getCacheTS()
Site	getClonedSite(java.lang.String... args)
java.lang.String	getConfigurationXML(java.lang.String... args)
java.lang.String	getCorsAllowedHosts(java.lang.String... args)
Page	getDefaultPage(java.lang.String... args)
java.lang.String	getDisplaySiteTitle(java.lang.String... args)
Page	getErrorPage(java.lang.String... args)
DBFile	getFavicon(java.lang.String... args)
SiteFramework	getFramework(java.lang.String... args) Deprecated.
java.lang.String	getGoogleTrackingID(java.lang.String... args)
java.lang.String	getHandlebarsHelper(java.lang.String... args)
java.lang.String	getHostNames(java.lang.String... args)
JSONObject	getJSONObject()
int	getLastPageSequence(java.lang.String... args)
java.util.Date	getLatestPublishedTS() if a site is created in aspc_app layer, and it's published in demo layer on 1 Apr 2015, and published on 15 Apr 2015 in aspc_app layer, getPublishedTS() will return the published time in the current layer, but this method will search current layer and all lower layers to find the latest published time, so it will return 15 Apr 2015 even current layer is demo.
int	getManifestBackgroundColor(java.lang.String... args)
java.lang.String	getManifestDescription(java.lang.String... args)
java.lang.String	getManifestDir(java.lang.String... args)
WebAppManifestDisplay	getManifestDisplay(java.lang.String... args)
java.lang.String	getManifestLanguage(java.lang.String... args)
java.lang.String	getManifestName(java.lang.String... args)
java.lang.String	getManifestOrientation(java.lang.String... args)
java.lang.String	getManifestRelatedApplications(java.lang.String... args)
java.lang.String	getManifestShortName(java.lang.String... args)
java.lang.String	getManifestStartURL(java.lang.String... args)
int	getManifestThemeColor(java.lang.String... args)
Page	getMissingPage(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
java.util.Date	getPublishedTS(java.lang.String... args)
SiteRevision	getPublshedSiteRevision(java.lang.String... args)
java.lang.String	getRedirectToHost(java.lang.String... args)
double	getScore(java.lang.String... args)
int	getSequence(java.lang.String... args)
java.lang.String	getServiceWorker(java.lang.String... args)
java.lang.String	getSiteTitle(java.lang.String... args)
SiteStatus	getStatus(java.lang.String... args)
DBFile	getStatusIcon(java.lang.String... args)
java.lang.String	getV2ArticleHandlebars(java.lang.String... args) Deprecated.
SiteFeedParser	getV2ArticleParser(java.lang.String... args) Deprecated.
int	getVersionNumber(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)
boolean	isDoNotIndex(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
boolean	isIntranetOnly()
boolean	isManifestPreferRelatedApps(java.lang.String... args)
boolean	isProgressiveWebApp(java.lang.String... args)
boolean	isPublicAccess(java.lang.String... args)
boolean	isPublished(java.lang.String... args)
static DBQuery<Site>	makeQuery(DataSource ds) Make a new QUERY for this class.
java.lang.String	makeThemeColor(ClientBrowser browser)
boolean	markDirty() Make the site as dirty.
Page	missingPage()
void	offline() put this site offline
void	publish() publish this site
Site	setAppleTouchIcon(com.aspc.dal.file.DBFile value, java.lang.String... args)
Site	setAppleTouchIconPrecomposed(com.aspc.dal.file.DBFile value, java.lang.String... args)
Site	setArticleFeedComponent(com.aspc.dal.cms.component.FeedComponent value, java.lang.String... args)
Site	setClonedSite(com.aspc.dal.cms.Site value, java.lang.String... args)
Site	setConfigurationXML(java.lang.String value, java.lang.String... args)
Site	setCorsAllowedHosts(java.lang.String value, java.lang.String... args)
Site	setDefaultPage(com.aspc.dal.cms.SitePage value, java.lang.String... args)
Site	setDoNotIndex(boolean value, java.lang.String... args)
Site	setErrorPage(com.aspc.dal.cms.SitePage value, java.lang.String... args)
Site	setFavicon(com.aspc.dal.file.DBFile value, java.lang.String... args)
Site	setFinalFg(boolean value, java.lang.String... args)
Site	setFramework(com.aspc.dal.cms.SiteFramework value, java.lang.String... args) Deprecated.
Site	setGoogleTrackingID(java.lang.String value, java.lang.String... args)
Site	setHandlebarsHelper(java.lang.String value, java.lang.String... args)
Site	setHostNames(java.lang.String value, java.lang.String... args)
Site	setLastPageSequence(int value, java.lang.String... args)
Site	setManifestBackgroundColor(int value, java.lang.String... args)
Site	setManifestDescription(java.lang.String value, java.lang.String... args)
Site	setManifestDir(java.lang.String value, java.lang.String... args)
Site	setManifestDisplay(com.aspc.dal.cms.manifest.WebAppManifestDisplay value, java.lang.String... args)
Site	setManifestLanguage(java.lang.String value, java.lang.String... args)
Site	setManifestName(java.lang.String value, java.lang.String... args)
Site	setManifestOrientation(java.lang.String value, java.lang.String... args)
Site	setManifestPreferRelatedApps(boolean value, java.lang.String... args)
Site	setManifestRelatedApplications(java.lang.String value, java.lang.String... args)
Site	setManifestShortName(java.lang.String value, java.lang.String... args)
Site	setManifestStartURL(java.lang.String value, java.lang.String... args)
Site	setManifestThemeColor(int value, java.lang.String... args)
Site	setMissingPage(com.aspc.dal.cms.SitePage value, java.lang.String... args)
Site	setName(java.lang.String value, java.lang.String... args)
Site	setNotes(java.lang.String value, java.lang.String... args)
Site	setProgressiveWebApp(boolean value, java.lang.String... args)
Site	setPublicAccess(boolean value, java.lang.String... args)
Site	setPublished(boolean value, java.lang.String... args)
Site	setPublishedTS(java.util.Date value, java.lang.String... args)
Site	setPublshedSiteRevision(com.aspc.dal.cms.SiteRevision value, java.lang.String... args)
Site	setRedirectToHost(java.lang.String value, java.lang.String... args)
Site	setSequence(int value, java.lang.String... args)
Site	setServiceWorker(java.lang.String value, java.lang.String... args)
Site	setSiteTitle(java.lang.String value, java.lang.String... args)
Site	setUseArchiveVersion(boolean value, java.lang.String... args)
Site	setV2ArticleHandlebars(java.lang.String value, java.lang.String... args) Deprecated.
Site	setV2ArticleParser(com.aspc.dal.cms.SiteFeedParser value, java.lang.String... args) Deprecated.
Site	setVersionNumber(int value, java.lang.String... args)
java.lang.String	toString() The description.
boolean	useArchiveVersion(java.lang.String... args)
void	vetoPublish()

Methods inherited from class com.aspc.cms.SiteTemplate

getID, setID

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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPreDeleteRecord, extPreValidateDelete, 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 site definition

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The site definition

ATTRIBUTE_SITE_CLONE

public static final java.lang.String ATTRIBUTE_SITE_CLONE

See Also:

Constant Field Values

Constructor Detail

Site

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

getAppleTouchIcon

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

findAppleTouchIcon

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

apple touch icon.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setAppleTouchIcon

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

Throws:

java.lang.Exception

getAppleTouchIconPrecomposed

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

findAppleTouchIconPrecomposed

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

apple touch icon precomposed.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setAppleTouchIconPrecomposed

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

Throws:

java.lang.Exception

getArchiveTS

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

getArticleFeedComponent

@CheckReturnValue
 @Nullable
public FeedComponent getArticleFeedComponent(java.lang.String... args)

findArticleFeedComponent

@CheckReturnValue
 @Nonnull
public final FeedComponent findArticleFeedComponent(java.lang.String... args)
                                                                         throws NotFoundException

The article feed component.

--> FeedComponent (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

RSS Feed

Throws:

NotFoundException - FeedComponent was not found

setArticleFeedComponent

@Nonnull
public Site setArticleFeedComponent(com.aspc.dal.cms.component.FeedComponent value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getClonedSite

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

findClonedSite

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

cloned site.

--> Site (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Site

Throws:

NotFoundException - Site was not found

setClonedSite

@Nonnull
public Site setClonedSite(com.aspc.dal.cms.Site 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 Site setConfigurationXML(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getCorsAllowedHosts

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

setCorsAllowedHosts

@Nonnull
public Site setCorsAllowedHosts(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultPage

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

findDefaultPage

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

The default page.

--> SitePage (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SitePage

Throws:

NotFoundException - SitePage was not found

setDefaultPage

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

Throws:

java.lang.Exception

getDisplaySiteTitle

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

isDoNotIndex

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

setDoNotIndex

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

Throws:

java.lang.Exception

getErrorPage

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

findErrorPage

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

The error page.

--> SitePage (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SitePage

Throws:

NotFoundException - SitePage was not found

setErrorPage

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

Throws:

java.lang.Exception

getFavicon

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

findFavicon

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

A favicon /ˈfævɪkɒn/ (short for Favorite icon), also known as a shortcut icon, Web site icon, URL icon, or bookmark icon,.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setFavicon

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

Throws:

java.lang.Exception

isFinalFg

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

setFinalFg

@Nonnull
public Site setFinalFg(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 framework to use.

--> SiteFramework (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteFramework

Throws:

NotFoundException - SiteFramework was not found

setFramework

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

Deprecated.

Throws:

java.lang.Exception

getGoogleTrackingID

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

setGoogleTrackingID

@Nonnull
public Site setGoogleTrackingID(@MatchesPattern(value="UA-[0-9]{4,9}-[0-9]{1,4}")
                                         java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getHandlebarsHelper

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

setHandlebarsHelper

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

Throws:

java.lang.Exception

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)

getHostNames

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

setHostNames

@Nonnull
public Site setHostNames(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getLastPageSequence

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

setLastPageSequence

@Nonnull
public Site setLastPageSequence(int value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getManifestBackgroundColor

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

setManifestBackgroundColor

@Nonnull
public Site setManifestBackgroundColor(int value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getManifestDescription

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

setManifestDescription

@Nonnull
public Site setManifestDescription(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getManifestDir

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

setManifestDir

@Nonnull
public Site setManifestDir(@MatchesPattern(value="(rtl|ltr|auto)")
                                    java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getManifestDisplay

@CheckReturnValue
 @Nullable
public WebAppManifestDisplay getManifestDisplay(java.lang.String... args)

findManifestDisplay

@CheckReturnValue
 @Nonnull
public final WebAppManifestDisplay findManifestDisplay(java.lang.String... args)
                                                                            throws NotFoundException

Defines the developer's preferred display mode for the web application.

--> WebAppManifestDisplay (String, Searchable)

Parameters:

args - the optional arguments

Returns:

WebAppManifestDisplay

Throws:

NotFoundException - WebAppManifestDisplay was not found

setManifestDisplay

@Nonnull
public Site setManifestDisplay(com.aspc.dal.cms.manifest.WebAppManifestDisplay value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getManifestLanguage

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

setManifestLanguage

@Nonnull
public Site setManifestLanguage(@MatchesPattern(value="[a-z]{2}-[A-Z]{2}")
                                         java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getManifestName

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

setManifestName

@Nonnull
public Site setManifestName(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getManifestOrientation

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

setManifestOrientation

@Nonnull
public Site setManifestOrientation(@MatchesPattern(value="(any|natural|landscape|landscape-primary|landscape-secondary|portrait|portrait-primary|portrait-secondary)")
                                            java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isManifestPreferRelatedApps

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

setManifestPreferRelatedApps

@Nonnull
public Site setManifestPreferRelatedApps(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getManifestRelatedApplications

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

setManifestRelatedApplications

@Nonnull
public Site setManifestRelatedApplications(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getManifestShortName

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

setManifestShortName

@Nonnull
public Site setManifestShortName(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getManifestStartURL

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

setManifestStartURL

@Nonnull
public Site setManifestStartURL(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getManifestThemeColor

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

setManifestThemeColor

@Nonnull
public Site setManifestThemeColor(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getMissingPage

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

findMissingPage

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

The missing page.

--> SitePage (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SitePage

Throws:

NotFoundException - SitePage was not found

setMissingPage

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

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public Site setName(java.lang.String 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 Site setNotes(java.lang.String value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

isProgressiveWebApp

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

setProgressiveWebApp

@Nonnull
public Site setProgressiveWebApp(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isPublicAccess

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

setPublicAccess

@Nonnull
public Site setPublicAccess(boolean value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

isPublished

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

setPublished

@Nonnull
public Site setPublished(boolean value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getPublishedTS

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

setPublishedTS

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

Throws:

java.lang.Exception

getPublshedSiteRevision

@CheckReturnValue
 @Nullable
public SiteRevision getPublshedSiteRevision(java.lang.String... args)

findPublshedSiteRevision

@CheckReturnValue
 @Nonnull
public final SiteRevision findPublshedSiteRevision(java.lang.String... args)
                                                                        throws NotFoundException

The version of the site that is currently published.

--> SiteRevision (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteRevision

Throws:

NotFoundException - SiteRevision was not found

setPublshedSiteRevision

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

Throws:

java.lang.Exception

getRedirectToHost

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

setRedirectToHost

@Nonnull
public Site setRedirectToHost(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getScore

@CheckReturnValue
public double getScore(java.lang.String... args)

getSequence

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

setSequence

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

Throws:

java.lang.Exception

getServiceWorker

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

setServiceWorker

@Nonnull
public Site setServiceWorker(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getSiteTitle

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

setSiteTitle

@Nonnull
public Site setSiteTitle(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

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

findStatus

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

Site Status.

--> SiteStatus (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Site Status

Throws:

NotFoundException - SiteStatus was not found

getStatusIcon

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

findStatusIcon

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

Statis Icon DBFile.

--> DBFile (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

useArchiveVersion

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

setUseArchiveVersion

@Nonnull
public Site setUseArchiveVersion(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getV2ArticleHandlebars

@Deprecated
 @CheckReturnValue
 @Nonnull
public java.lang.String getV2ArticleHandlebars(java.lang.String... args)

Deprecated.

setV2ArticleHandlebars

@Deprecated
 @Nonnull
public Site setV2ArticleHandlebars(java.lang.String value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getV2ArticleParser

@Deprecated
 @CheckReturnValue
 @Nullable
public SiteFeedParser getV2ArticleParser(java.lang.String... args)

Deprecated.

findV2ArticleParser

@CheckReturnValue
 @Deprecated
 @Nonnull
public final SiteFeedParser findV2ArticleParser(java.lang.String... args)
                                                                                  throws NotFoundException

Deprecated.

Default Article template parser.

--> SiteFeedParser (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteFeedParser

Throws:

NotFoundException - SiteFeedParser was not found

setV2ArticleParser

@Deprecated
 @Nonnull
public Site setV2ArticleParser(com.aspc.dal.cms.SiteFeedParser value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getVersionNumber

@CheckReturnValue
 @Nonnegative
public int getVersionNumber(java.lang.String... args)

setVersionNumber

@Nonnull
public Site setVersionNumber(int value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

create

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

getCacheTS

@CheckReturnValue
 @Nonnull
public java.util.Date getCacheTS()

cleanSite

@Nonnull
 @CheckReturnValue
public Site cleanSite()

Clean the site ( use archive if needed)

Returns:

the clean/safe site.

extPostSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database. At this stage the database transaction has been committed. YOU MAY NOT CHANGE THE UNIVERSE AT THIS STAGE.

Overrides:

extPostSaveRecord in class DBObject

Parameters:

transNr - This transaction number that was just saved.

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

adjustReason

public java.lang.String adjustReason(java.lang.String reason,
                                     boolean first)
                              throws java.lang.Exception

Description copied from interface: AdjustTransactionReason

adjust the reason

Specified by:

adjustReason in interface AdjustTransactionReason

Parameters:

reason - the original reason.

first - the first one

Returns:

the new reason

Throws:

java.lang.Exception - a serious problem.

getLatestPublishedTS

public java.util.Date getLatestPublishedTS()

if a site is created in aspc_app layer, and it's published in demo layer on 1 Apr 2015, and published on 15 Apr 2015 in aspc_app layer, getPublishedTS() will return the published time in the current layer, but this method will search current layer and all lower layers to find the latest published time, so it will return 15 Apr 2015 even current layer is demo. This is used to fix the issue of archived /DCSS

Returns:

published date

addStyle

public void addStyle(WebClient client,
                     HTMLPage page,
                     CascadingStyleSheet css,
                     java.lang.String media)
              throws java.lang.Exception

Throws:

java.lang.Exception

addStyle

public void addStyle(WebClient client,
                     HTMLPage page,
                     CascadingStyleSheet css,
                     java.lang.String media,
                     java.util.Date publishedTS)
              throws java.lang.Exception

Throws:

java.lang.Exception

eventFieldUpdated

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

Description copied from class: DBObject

OVERRIDE This method to be notified when a field changes. This method should not trigger a save of this record because you may save a record in a half updated state.
TODO: Put in a programmer check for a save during this method call.

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

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

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

extValidateField

@Nullable
 @CheckReturnValue
 @OverridingMethodsMustInvokeSuper
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

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

defaultPage

public Page defaultPage()

missingPage

public Page missingPage()

errorPage

public Page errorPage()

toString

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

Description copied from class: DBObject

The description.

Overrides:

toString in class DBObject

Returns:

The description

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

isIntranetOnly

public boolean isIntranetOnly()
                       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.

vetoPublish

public void vetoPublish()
                 throws java.lang.Exception

Throws:

java.lang.Exception

publish

public void publish()
             throws java.lang.Exception

publish this site

Throws:

java.lang.Exception - a serious problem.

offline

public void offline()
             throws java.lang.Exception

put this site offline

Throws:

java.lang.Exception - a serious problem.

getJSONObject

public JSONObject getJSONObject()

markDirty

public boolean markDirty()
                  throws java.lang.Exception

Make the site as dirty.

Returns:

true if we set to dirty.

Throws:

java.lang.Exception - a serious problem

findPage

public Page findPage(boolean publishedOnly,
                     java.lang.String pagePath,
                     java.lang.String queryString,
                     ClientBrowser browser)
              throws java.lang.Exception

get the page

Parameters:

publishedOnly - is getting published page

pagePath - page path

queryString - http request query string

browser - The browser.

Returns:

matched page

Throws:

java.lang.Exception - a serious problem.

makeThemeColor

public java.lang.String makeThemeColor(ClientBrowser browser)