com.aspc.cms.rest

Class RestMagicNumber

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.magic.DBMagicNumber

com.aspc.cms.rest.RestMagicNumber

All Implemented Interfaces:

SecondaryCacheGroup

public class RestMagicNumber
extends DBMagicNumber

ReST magic number.

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

Since:

08 January 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 ReST magic number
static java.lang.String	DBCLASS_NAME ReST magic number

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestMagicNumber(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extFixUp() fixes the following problem 1) Blank Type.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
RestDefinition	findDefinition(java.lang.String... args) The ReST definition.
RestDefinition	getDefinition(java.lang.String... args)
java.lang.String	getExampleCall(java.lang.String... args)
java.lang.String	getProperties(java.lang.String... args)
RestMagicNumber	setDefinition(com.aspc.dal.cms.rest.RestDefinition value, java.lang.String... args)
RestMagicNumber	setProperties(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.magic.DBMagicNumber

create, extCheckDeleteAccess, extCheckModifyAccess, extValidateField, find, findContact, findKey, findTimezone, findType, findUser, getActualCallCount, getBatch, getCommand, getContact, getExpiry, getMagicNumber, getMaxCallCount, getSearchKey, getTargetLayerID, getTimezone, getType, getUser, isValid, isValidToExpunge, makeQuery, processMagicNumber, setActualCallCount, setBatch, setCommand, setContact, setExpiry, setMagicNumber, setMaxCallCount, setSearchKey, setTargetLayerID, setTimezone, setType, setUser

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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

ReST magic number

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

ReST magic number

Constructor Detail

RestMagicNumber

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

Throws:

java.lang.Exception

Method Detail

getDefinition

@CheckReturnValue
 @Nullable
public RestDefinition getDefinition(java.lang.String... args)

findDefinition

@CheckReturnValue
 @Nonnull
public final RestDefinition findDefinition(java.lang.String... args)
                                                                throws NotFoundException

The ReST definition.

--> RestDefinition (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

ReST Definition

Throws:

NotFoundException - RestDefinition was not found

setDefinition

@Nonnull
public RestMagicNumber setDefinition(com.aspc.dal.cms.rest.RestDefinition value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getExampleCall

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

getProperties

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

setProperties

@Nonnull
public RestMagicNumber setProperties(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

Description copied from class: DBMagicNumber

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBMagicNumber

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

fixes the following problem 1) Blank Type.

Overrides:

extFixUp in class DBMagicNumber

Throws:

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 DBMagicNumber

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