com.aspc.cms.script

Class ScriptLink

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.script.ScriptLink

All Implemented Interfaces:

SecondaryCacheGroup

public class ScriptLink
extends DBObject

The scripts to be included in a page.

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 scripts to be included in a page
static java.lang.String	DBCLASS_NAME The scripts to be included in a page

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ScriptLink	create(MutableDataSource mds) Make a new instance of this class.
protected void	extPreDeleteRecord() OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from the database.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
static ScriptLink	findKey(DataSource ds, int key) Find the target for this class by the primary key
ScriptMode	findMode(java.lang.String... args) The script mode.
SiteScriptModule	findModule(java.lang.String... args) Script module.
Page	findPage(java.lang.String... args) The page for this script.
SiteScriptVersion	findPublishedScriptVersion(java.lang.String... args) The matching script version when the site was published.
int	getID(java.lang.String... args)
double	getMaxVersion(java.lang.String... args)
ScriptMode	getMode(java.lang.String... args)
SiteScriptModule	getModule(java.lang.String... args)
Page	getPage(java.lang.String... args)
SiteScriptVersion	getPublishedScriptVersion(java.lang.String... args)
java.lang.String	getScriptURI(java.lang.String... args)
int	getSequence(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
static DBQuery<ScriptLink>	makeQuery(DataSource ds) Make a new QUERY for this class.
java.lang.String	makeURI(ClientBrowser browser, ModuleBuilder builder)
ScriptLink	setFinalFg(boolean value, java.lang.String... args)
ScriptLink	setID(int value, java.lang.String... args)
ScriptLink	setMaxVersion(double value, java.lang.String... args)
ScriptLink	setMode(com.aspc.dal.cms.script.SiteScriptMode value, java.lang.String... args)
ScriptLink	setModule(com.aspc.dal.cms.module.SiteScriptModule value, java.lang.String... args)
ScriptLink	setPage(com.aspc.dal.cms.SitePage value, java.lang.String... args)
ScriptLink	setPublishedScriptVersion(com.aspc.dal.cms.module.SiteScriptVersion value, java.lang.String... args)
ScriptLink	setScriptURI(java.lang.String value, java.lang.String... args)
ScriptLink	setSequence(int value, java.lang.String... args)
void	sitePublish()

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, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, 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

The scripts to be included in a page

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The scripts to be included in a page

Constructor Detail

ScriptLink

public ScriptLink(DBClass def,
                  DataSource dataSource)
           throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

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

setID

@Nonnull
public ScriptLink setID(int 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 ScriptLink setFinalFg(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getMaxVersion

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

setMaxVersion

@Nonnull
public ScriptLink setMaxVersion(double value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getMode

@CheckReturnValue
 @Nullable
public ScriptMode getMode(java.lang.String... args)

findMode

@CheckReturnValue
 @Nonnull
public final ScriptMode findMode(java.lang.String... args)
                                                      throws NotFoundException

The script mode.

--> SiteScriptMode (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteScriptMode

Throws:

NotFoundException - SiteScriptMode was not found

setMode

@Nonnull
public ScriptLink setMode(com.aspc.dal.cms.script.SiteScriptMode value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getModule

@CheckReturnValue
 @Nullable
public SiteScriptModule getModule(java.lang.String... args)

findModule

@CheckReturnValue
 @Nonnull
public final SiteScriptModule findModule(java.lang.String... args)
                                                              throws NotFoundException

Script module. Module will be used only when the URI is not entered

--> SiteScriptModule (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteScriptModule

Throws:

NotFoundException - SiteScriptModule was not found

setModule

@Nonnull
public ScriptLink setModule(com.aspc.dal.cms.module.SiteScriptModule value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getPage

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

findPage

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

The page for this script.

--> SitePage (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

SitePage

Throws:

NotFoundException - SitePage was not found

setPage

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

Throws:

java.lang.Exception

getPublishedScriptVersion

@CheckReturnValue
 @Nullable
public SiteScriptVersion getPublishedScriptVersion(java.lang.String... args)

findPublishedScriptVersion

@CheckReturnValue
 @Nonnull
public final SiteScriptVersion findPublishedScriptVersion(java.lang.String... args)
                                                                               throws NotFoundException

The matching script version when the site was published.

--> SiteScriptVersion (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteScriptVersion

Throws:

NotFoundException - SiteScriptVersion was not found

setPublishedScriptVersion

@Nonnull
public ScriptLink setPublishedScriptVersion(com.aspc.dal.cms.module.SiteScriptVersion value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getScriptURI

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

setScriptURI

@Nonnull
public ScriptLink setScriptURI(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getSequence

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

setSequence

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

Throws:

java.lang.Exception

create

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

sitePublish

public void sitePublish()
                 throws java.lang.Exception

Throws:

java.lang.Exception

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

makeURI

@Nullable
 @CheckReturnValue
public java.lang.String makeURI(@Nonnull
                                                             ClientBrowser browser,
                                                             @Nonnull
                                                             ModuleBuilder builder)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

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

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