com.aspc.cms.variable

Class SiteConfigurationVarValues

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.variable.SiteConfigurationVarValues

All Implemented Interfaces:

SecondaryCacheGroup

public class SiteConfigurationVarValues
extends DBObject

Possible values of SiteconfigurationVariable.

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 Possible values of SiteconfigurationVariable
static java.lang.String	DBCLASS_NAME Possible values of SiteconfigurationVariable

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
SiteConfigurationVarValues(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static SiteConfigurationVarValues	create(MutableDataSource mds) Make a new instance of this class.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
DBFile	findDisplayImage(java.lang.String... args) Display Image.
static SiteConfigurationVarValues	findKey(DataSource ds, int key) Find the target for this class by the primary key
SiteConfigurationVariable	findVariable(java.lang.String... args) linked SiteConfigurationVariable.
java.lang.String	getDisplayColor(java.lang.String... args)
DBFile	getDisplayImage(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getLabel(java.lang.String... args)
java.lang.String	getVal(java.lang.String... args)
SiteConfigurationVariable	getVariable(java.lang.String... args)
static DBQuery<SiteConfigurationVarValues>	makeQuery(DataSource ds) Make a new QUERY for this class.
SiteConfigurationVarValues	setDisplayColor(java.lang.String value, java.lang.String... args)
SiteConfigurationVarValues	setDisplayImage(com.aspc.dal.file.DBFile value, java.lang.String... args)
SiteConfigurationVarValues	setID(int value, java.lang.String... args)
SiteConfigurationVarValues	setLabel(java.lang.String value, java.lang.String... args)
SiteConfigurationVarValues	setVal(java.lang.String value, java.lang.String... args)
SiteConfigurationVarValues	setVariable(com.aspc.dal.cms.variable.SiteConfigurationVariable value, java.lang.String... args)

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, extPreDeleteRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, 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

Possible values of SiteconfigurationVariable

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Possible values of SiteconfigurationVariable

Constructor Detail

SiteConfigurationVarValues

public SiteConfigurationVarValues(DBClass theClass,
                                  DataSource dataSource)
                           throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getID

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

setID

@Nonnull
public SiteConfigurationVarValues setID(int value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayColor

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

setDisplayColor

@Nonnull
public SiteConfigurationVarValues setDisplayColor(java.lang.String value,
                                                           java.lang.String... args)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayImage

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

findDisplayImage

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

Display Image.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setDisplayImage

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

Throws:

java.lang.Exception

getLabel

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

setLabel

@Nonnull
public SiteConfigurationVarValues setLabel(java.lang.String value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getVal

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

setVal

@Nonnull
public SiteConfigurationVarValues setVal(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getVariable

@CheckReturnValue
 @Nullable
public SiteConfigurationVariable getVariable(java.lang.String... args)

findVariable

@CheckReturnValue
 @Nonnull
public final SiteConfigurationVariable findVariable(java.lang.String... args)
                                                                         throws NotFoundException

linked SiteConfigurationVariable.

--> SiteConfigurationVariable (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteConfigurationVariable

Throws:

NotFoundException - SiteConfigurationVariable was not found

setVariable

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

Throws:

java.lang.Exception

create

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

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