com.aspc.cms.variable

Class SiteConfigurationVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.variable.SiteVariable

com.aspc.cms.variable.single.SingleValueVariable

com.aspc.cms.variable.SiteConfigurationVariable

All Implemented Interfaces:

SecondaryCacheGroup

public class SiteConfigurationVariable
extends SingleValueVariable

Site Configuration Variable.

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

Since:

02 September 2014

Author:

Lei Gao

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 Site Configuration Variable
static java.lang.String	DBCLASS_NAME Site Configuration Variable

Fields inherited from class com.aspc.cms.variable.SiteVariable

DEFAULT_VARIABLE_ENCODE, WEB_CLIENT

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
SiteConfigurationVariable(DBClass def, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
java.lang.String	calculateResult(WebClient wc, java.util.HashMap<java.lang.String,SiteVariableCalculation> variables, SiteComponent component)
static SiteConfigurationVarGroup	cloneGroup(MutableDataSource mds, Site clonedSite, SiteConfigurationVarGroup srcObj, java.util.HashMap<java.lang.Long,DBObject> clonedMap)
protected void	extCopy(DBObject target) Additional functionality when an object is copied.
protected boolean	extIsMandatory(DBField field) OVERRIDE This method to specify fields should be mandatory under certain conditions.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
SiteConfigurationVarType	findType(java.lang.String... args) Variable Type.
SiteConfigurationVarGroup	findVarGroup(java.lang.String... args) Variable Group.
SiteConfigurationVarValues	findVarValue(java.lang.String... args) Value of the variable.
SiteConfigurationVarType	getType(java.lang.String... args)
SiteConfigurationVarGroup	getVarGroup(java.lang.String... args)
SiteConfigurationVarValues	getVarValue(java.lang.String... args)
static SiteConfigurationVarValues	makeClone(MutableDataSource mds, SiteConfigurationVarValues srcObj, java.util.HashMap<java.lang.Long,DBObject> clonedMap)
SiteConfigurationVariable	setType(com.aspc.dal.cms.variable.SiteConfigurationVarType value, java.lang.String... args)
SiteConfigurationVariable	setVarGroup(com.aspc.dal.cms.variable.SiteConfigurationVarGroup value, java.lang.String... args)
SiteConfigurationVariable	setVarValue(com.aspc.dal.cms.variable.SiteConfigurationVarValues value, java.lang.String... args)

Methods inherited from class com.aspc.cms.variable.single.SingleValueVariable

encodeValue, extGetDerivedValue, findEncoding, getDefault, getEncoding, setDefault, setEncoding

Methods inherited from class com.aspc.cms.variable.SiteVariable

calculateJSON, extGetDerivedGlobalKey, extPreValidate, extValidateRecord, findComponent, findInheritedByComponent, findKey, findOwnedBySite, findSite, getComponent, getID, getInheritedByComponent, getLabel, getName, getOwnedBySite, getPath, getResult, getSequence, getSite, isVisibleToThisComponent, makeQuery, setComponent, setID, setLabel, setName, setSequence, setSite

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, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, 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

Site Configuration Variable

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Site Configuration Variable

Constructor Detail

SiteConfigurationVariable

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

Throws:

java.lang.Exception

Method Detail

getType

@CheckReturnValue
 @Nullable
public SiteConfigurationVarType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final SiteConfigurationVarType findType(java.lang.String... args)
                                                                    throws NotFoundException

Variable Type.

--> SiteConfigurationVarType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteConfigurationVarType

Throws:

NotFoundException - SiteConfigurationVarType was not found

setType

@Nonnull
public SiteConfigurationVariable setType(com.aspc.dal.cms.variable.SiteConfigurationVarType value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getVarGroup

@CheckReturnValue
 @Nullable
public SiteConfigurationVarGroup getVarGroup(java.lang.String... args)

findVarGroup

@CheckReturnValue
 @Nonnull
public final SiteConfigurationVarGroup findVarGroup(java.lang.String... args)
                                                                         throws NotFoundException

Variable Group.

--> SiteConfigurationVarGroup (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteConfigurationVarGroup

Throws:

NotFoundException - SiteConfigurationVarGroup was not found

setVarGroup

@Nonnull
public SiteConfigurationVariable setVarGroup(com.aspc.dal.cms.variable.SiteConfigurationVarGroup value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getVarValue

@CheckReturnValue
 @Nullable
public SiteConfigurationVarValues getVarValue(java.lang.String... args)

findVarValue

@CheckReturnValue
 @Nonnull
public final SiteConfigurationVarValues findVarValue(java.lang.String... args)
                                                                          throws NotFoundException

Value of the variable.

--> SiteConfigurationVarValues (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteConfigurationVarValues

Throws:

NotFoundException - SiteConfigurationVarValues was not found

setVarValue

@Nonnull
public SiteConfigurationVariable setVarValue(com.aspc.dal.cms.variable.SiteConfigurationVarValues value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

calculateResult

public java.lang.String calculateResult(WebClient wc,
                                        java.util.HashMap<java.lang.String,SiteVariableCalculation> variables,
                                        SiteComponent component)
                                 throws java.lang.Exception

Specified by:

calculateResult in class SingleValueVariable

Throws:

java.lang.Exception

extCopy

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

Description copied from class: DBObject

Additional functionality when an object is copied.

Overrides:

extCopy in class DBObject

Parameters:

target - the target object

Throws:

java.lang.Exception - A serious problem

cloneGroup

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

Throws:

java.lang.Exception

makeClone

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

Throws:

java.lang.Exception

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Description copied from class: DBObject

OVERRIDE This method to specify fields should be mandatory under certain conditions.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to check

Returns:

true if the field should be treated as mandatory.

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