com.aspc.cms.rest.usage

Class RestDefinitionMonthlyUsage

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.rest.usage.RestDefinitionMonthlyUsage

All Implemented Interfaces:

SecondaryCacheGroup

public abstract class RestDefinitionMonthlyUsage
extends DBObject

ReST API monthly usage.

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

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 API monthly usage
static java.lang.String	DBCLASS_NAME ReST API monthly usage

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestDefinitionMonthlyUsage(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
static RestDefinitionMonthlyUsage	findKey(DataSource ds, int key) Find the target for this class by the primary key
RestDefinition	findRest(java.lang.String... args) ReST definition.
int	getCounter(java.lang.String... args)
java.lang.String	getDisplayMonth(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getMethod(java.lang.String... args)
int	getMonth(java.lang.String... args)
RestDefinition	getRest(java.lang.String... args)
static DBQuery<RestDefinitionMonthlyUsage>	makeQuery(DataSource ds) Make a new QUERY for this class.
RestDefinitionMonthlyUsage	setCounter(int value, java.lang.String... args)
RestDefinitionMonthlyUsage	setID(int value, java.lang.String... args)
RestDefinitionMonthlyUsage	setMethod(java.lang.String value, java.lang.String... args)
RestDefinitionMonthlyUsage	setMonth(int value, java.lang.String... args)
RestDefinitionMonthlyUsage	setRest(com.aspc.dal.cms.rest.RestDefinition 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, 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 API monthly usage

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

ReST API monthly usage

Constructor Detail

RestDefinitionMonthlyUsage

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

Throws:

java.lang.Exception

getCounter

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

setCounter

@Nonnull
public RestDefinitionMonthlyUsage setCounter(int value,
                                                      java.lang.String... args)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayMonth

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

getMethod

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

setMethod

@Nonnull
public RestDefinitionMonthlyUsage setMethod(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getMonth

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

setMonth

@Nonnull
public RestDefinitionMonthlyUsage setMonth(int value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getRest

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

findRest

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

ReST definition.

--> RestDefinition (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

ReST Definition

Throws:

NotFoundException - RestDefinition was not found

setRest

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

Throws:

java.lang.Exception

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<RestDefinitionMonthlyUsage> 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 RestDefinitionMonthlyUsage 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
 @Nullable
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

extValidateField

@OverridingMethodsMustInvokeSuper
 @CheckReturnValue
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error