com.aspc.cms.rest

Class RestDefinitionVariableSanity

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.rest.RestDefinitionVariableSanity

All Implemented Interfaces:

SecondaryCacheGroup

public class RestDefinitionVariableSanity
extends DBObject

Sanity checks for variables.

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

Since:

10 August 2015

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 Sanity checks for variables.
static java.lang.String	DBCLASS_NAME Sanity checks for variables.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestDefinitionVariableSanity(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static RestDefinitionVariableSanity	create(MutableDataSource mds) Make a new instance of this class.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
static RestDefinitionVariableSanity	findKey(DataSource ds, int key) Find the target for this class by the primary key
RestDefinitionVariable	findVariable(java.lang.String... args) The variable.
int	getActualStatus(java.lang.String... args)
java.lang.String	getActualValue(java.lang.String... args)
java.lang.String	getCheckValue(java.lang.String... args)
java.lang.String	getExpectedPattern(java.lang.String... args)
int	getExpectStatus(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getMessage(java.lang.String... args)
java.lang.String	getMessageHTML(java.lang.String... args)
RestDefinitionVariable	getVariable(java.lang.String... args)
boolean	isPassed(java.lang.String... args)
static DBQuery<RestDefinitionVariableSanity>	makeQuery(DataSource ds) Make a new QUERY for this class.
RestDefinitionVariableSanity	setCheckValue(java.lang.String value, java.lang.String... args)
RestDefinitionVariableSanity	setExpectedPattern(java.lang.String value, java.lang.String... args)
RestDefinitionVariableSanity	setExpectStatus(int value, java.lang.String... args)
RestDefinitionVariableSanity	setID(int value, java.lang.String... args)
RestDefinitionVariableSanity	setVariable(com.aspc.dal.cms.rest.RestDefinitionVariable 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, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, 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

Sanity checks for variables.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Sanity checks for variables.

Constructor Detail

RestDefinitionVariableSanity

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

Throws:

java.lang.Exception

getActualStatus

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

getActualValue

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

getCheckValue

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

setCheckValue

@Nonnull
public RestDefinitionVariableSanity setCheckValue(java.lang.String value,
                                                           java.lang.String... args)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getExpectStatus

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

setExpectStatus

@Nonnull
public RestDefinitionVariableSanity setExpectStatus(int value,
                                                             java.lang.String... args)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getExpectedPattern

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

setExpectedPattern

@Nonnull
public RestDefinitionVariableSanity setExpectedPattern(java.lang.String value,
                                                                java.lang.String... args)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

getMessage

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

getMessageHTML

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

isPassed

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

getVariable

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

findVariable

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

The variable.

--> RestDefinitionVariable (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

ReST Varaible

Throws:

NotFoundException - RestDefinitionVariable was not found

setVariable

@Nonnull
public RestDefinitionVariableSanity setVariable(com.aspc.dal.cms.rest.RestDefinitionVariable value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

create

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

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