com.aspc.cms.rest

Class RestDefinitionTag

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.rest.RestDefinitionTag

All Implemented Interfaces:

SecondaryCacheGroup

public class RestDefinitionTag
extends DBObject

Rest Definition Tag.

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

Since:

30 April 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 Rest Definition Tag
static java.lang.String	DBCLASS_NAME Rest Definition Tag
static java.lang.String	LIST_AUTH Auth
static java.lang.String	LIST_CMS CMS
static java.lang.String	LIST_CRUD CRUD
static java.lang.String	LIST_DEVELOPER Developer
static java.lang.String	LIST_EMAIL Email
static java.lang.String	LIST_FILES Files
static java.lang.String	LIST_INTERNAL Internal
static java.lang.String	LIST_MONITOR Monitor
static java.lang.String	LIST_PUBLIC Public
static java.lang.String	LIST_QUESTIONNAIRE Questionnaire
static java.lang.String	LIST_SCREEN Screen
static java.lang.String	LIST_SITE Site
static java.lang.String	LIST_TASK Task
static java.lang.String	LIST_TEXT Text
static java.lang.String	LIST_TRANSACTION Transaction
static java.lang.String	LIST_USER User

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestDefinitionTag(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static RestDefinitionTag	create(MutableDataSource mds) Make a new instance of this class.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
RestDefinitionExternalDocs	findExternalDocs(java.lang.String... args) The external docs.
static RestDefinitionTag	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getDescriptionHTML(java.lang.String... args)
RestDefinitionExternalDocs	getExternalDocs(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
int	getSequence(java.lang.String... args)
static DBQuery<RestDefinitionTag>	makeQuery(DataSource ds) Make a new QUERY for this class.
RestDefinitionTag	setCode(java.lang.String value, java.lang.String... args)
RestDefinitionTag	setDescriptionHTML(java.lang.String value, java.lang.String... args)
RestDefinitionTag	setExternalDocs(com.aspc.dal.cms.rest.RestDefinitionExternalDocs value, java.lang.String... args)
RestDefinitionTag	setName(java.lang.String value, java.lang.String... args)
RestDefinitionTag	setSequence(int 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, 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 Definition Tag

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Rest Definition Tag

LIST_AUTH

public static final java.lang.String LIST_AUTH

Auth

See Also:

Constant Field Values

LIST_CMS

public static final java.lang.String LIST_CMS

CMS

See Also:

Constant Field Values

LIST_CRUD

public static final java.lang.String LIST_CRUD

CRUD

See Also:

Constant Field Values

LIST_DEVELOPER

public static final java.lang.String LIST_DEVELOPER

Developer

See Also:

Constant Field Values

LIST_EMAIL

public static final java.lang.String LIST_EMAIL

Email

See Also:

Constant Field Values

LIST_FILES

public static final java.lang.String LIST_FILES

Files

See Also:

Constant Field Values

LIST_INTERNAL

public static final java.lang.String LIST_INTERNAL

Internal

See Also:

Constant Field Values

LIST_MONITOR

public static final java.lang.String LIST_MONITOR

Monitor

See Also:

Constant Field Values

LIST_PUBLIC

public static final java.lang.String LIST_PUBLIC

Public

See Also:

Constant Field Values

LIST_QUESTIONNAIRE

public static final java.lang.String LIST_QUESTIONNAIRE

Questionnaire

See Also:

Constant Field Values

LIST_SCREEN

public static final java.lang.String LIST_SCREEN

Screen

See Also:

Constant Field Values

LIST_SITE

public static final java.lang.String LIST_SITE

Site

See Also:

Constant Field Values

LIST_TASK

public static final java.lang.String LIST_TASK

Task

See Also:

Constant Field Values

LIST_TEXT

public static final java.lang.String LIST_TEXT

Text

See Also:

Constant Field Values

LIST_TRANSACTION

public static final java.lang.String LIST_TRANSACTION

Transaction

See Also:

Constant Field Values

LIST_USER

public static final java.lang.String LIST_USER

User

See Also:

Constant Field Values

Constructor Detail

RestDefinitionTag

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

Throws:

java.lang.Exception

Method Detail

getCode

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

setCode

@Nonnull
public RestDefinitionTag setCode(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDescriptionHTML

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

setDescriptionHTML

@Nonnull
public RestDefinitionTag setDescriptionHTML(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getExternalDocs

@CheckReturnValue
 @Nullable
public RestDefinitionExternalDocs getExternalDocs(java.lang.String... args)

findExternalDocs

@CheckReturnValue
 @Nonnull
public final RestDefinitionExternalDocs findExternalDocs(java.lang.String... args)
                                                                              throws NotFoundException

The external docs.

--> RestDefinitionExternalDocs (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

RestDefinitionExternalDocs

Throws:

NotFoundException - RestDefinitionExternalDocs was not found

setExternalDocs

@Nonnull
public RestDefinitionTag setExternalDocs(com.aspc.dal.cms.rest.RestDefinitionExternalDocs value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public RestDefinitionTag setName(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSequence

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

setSequence

@Nonnull
public RestDefinitionTag setSequence(int value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static RestDefinitionTag 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<RestDefinitionTag> 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 RestDefinitionTag findKey(@Nonnull
                                                                    DataSource ds,
                                                                    @Nonnull
                                                                    java.lang.String 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

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @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