com.aspc.cms.module

Class SiteResource

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.module.SiteResource

All Implemented Interfaces:

SecondaryCacheGroup

public class SiteResource
extends DBObject

Related Resource.

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

Since:

10 May 2016

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 Related Resource
static java.lang.String	DBCLASS_NAME Related Resource

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static SiteResource	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) OVERRIDE This method to be notified when a field changes.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected void	extPreValidateDelete() OVERRIDE To add functionality to before validation is called.
static SiteResource	findKey(DataSource ds, int key) Find the target for this class by the primary key
Site	findSite(java.lang.String... args) The related version.
SiteResourceType	findType(java.lang.String... args) The resource type.
java.lang.String	getCss(java.lang.String... args)
java.lang.String	getHtml(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getMinimizedData(java.lang.String... args)
java.lang.String	getMinimizedIntegrity(java.lang.String... args)
java.lang.String	getPath(java.lang.String... args)
java.lang.String	getRawPath(java.lang.String... args)
java.lang.String	getScript(java.lang.String... args)
Site	getSite(java.lang.String... args)
SiteResourceType	getType(java.lang.String... args)
static DBQuery<SiteResource>	makeQuery(DataSource ds) Make a new QUERY for this class.
SiteResource	setCss(java.lang.String value, java.lang.String... args)
SiteResource	setHtml(java.lang.String value, java.lang.String... args)
SiteResource	setID(int value, java.lang.String... args)
SiteResource	setMinimizedData(java.lang.String value, java.lang.String... args)
SiteResource	setMinimizedIntegrity(java.lang.String value, java.lang.String... args)
SiteResource	setPath(java.lang.String value, java.lang.String... args)
SiteResource	setRawPath(java.lang.String value, java.lang.String... args)
SiteResource	setScript(java.lang.String value, java.lang.String... args)
SiteResource	setSite(com.aspc.dal.cms.Site value, java.lang.String... args)
SiteResource	setType(com.aspc.dal.cms.module.SiteResourceType value, java.lang.String... args)
java.lang.String	toString() The description.

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, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, 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, 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

Related Resource

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Related Resource

Constructor Detail

SiteResource

public SiteResource(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 SiteResource setID(int value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getCss

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

setCss

@Nonnull
public SiteResource setCss(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getHtml

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

setHtml

@Nonnull
public SiteResource setHtml(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getMinimizedData

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

setMinimizedData

@Nonnull
public SiteResource setMinimizedData(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getMinimizedIntegrity

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

setMinimizedIntegrity

@Nonnull
public SiteResource setMinimizedIntegrity(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getPath

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

setPath

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

Throws:

java.lang.Exception

getRawPath

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

setRawPath

@Nonnull
public SiteResource setRawPath(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getScript

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

setScript

@Nonnull
public SiteResource setScript(java.lang.String 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 related version.

--> Site (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Site

Throws:

NotFoundException - Site was not found

setSite

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

Throws:

java.lang.Exception

getType

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

findType

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

The resource type.

--> SiteResourceType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Resource Type

Throws:

NotFoundException - SiteResourceType was not found

setType

@Nonnull
public SiteResource setType(com.aspc.dal.cms.module.SiteResourceType value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

create

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

extPreValidateDelete

@OverridingMethodsMustInvokeSuper
protected void extPreValidateDelete()
                                                               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 FOR DELETED RECORDS.

Overrides:

extPreValidateDelete in class DBObject

Throws:

java.lang.Exception - a serious problem

toString

public java.lang.String toString()

Description copied from class: DBObject

The description.

Overrides:

toString in class DBObject

Returns:

The description

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

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