com.aspc.cms.rest

Class RestDefinitionVariableType

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.rest.RestDefinitionVariableType

All Implemented Interfaces:

SecondaryCacheGroup

public class RestDefinitionVariableType
extends DBObject

Data types for the ReST variables.

Notes

Data Types

Primitive data types in the Swagger Specification are based on the types supported by the JSON-Schema Draft 4. Models are described using the Schema Object which is a subset of JSON Schema Draft 4.

An additional primitive data type "file" is used by the Parameter Object and the Response Object to set the parameter type or the response as being a file.

Primitives have an optional modifier property format. Swagger uses several known formats to more finely define the data type being used. However, the format property is an open string-valued property, and can have any value to support documentation needs. Formats such as "email", "uuid", etc., can be used even though they are not defined by this specification. Types that are not accompanied by a format property follow their definition from the JSON Schema (except for file type which is defined above).

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 Data types for the ReST variables.
static java.lang.String	DBCLASS_NAME Data types for the ReST variables.
static java.lang.String	LIST_BOOLEAN RestDefinitionVariableType: boolean
static java.lang.String	LIST_BYTE RestDefinitionVariableType: byte
static java.lang.String	LIST_DATE RestDefinitionVariableType: date
static java.lang.String	LIST_DATE_TIME RestDefinitionVariableType: dateTime
static java.lang.String	LIST_DOUBLE RestDefinitionVariableType: double
static java.lang.String	LIST_FILE RestDefinitionVariableType: file
static java.lang.String	LIST_FLOAT RestDefinitionVariableType: float
static java.lang.String	LIST_INTEGER RestDefinitionVariableType: integer
static java.lang.String	LIST_LONG RestDefinitionVariableType: long
static java.lang.String	LIST_PASSWORD RestDefinitionVariableType: password
static java.lang.String	LIST_STRING RestDefinitionVariableType: string

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestDefinitionVariableType(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static RestDefinitionVariableType	create(MutableDataSource mds) Make a new instance of this class.
static RestDefinitionVariableType	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	getComments(java.lang.String... args)
java.lang.String	getCommonName(java.lang.String... args)
java.lang.String	getFormat(java.lang.String... args)
java.lang.String	getType(java.lang.String... args)
static DBQuery<RestDefinitionVariableType>	makeQuery(DataSource ds) Make a new QUERY for this class.
RestDefinitionVariableType	setCode(java.lang.String value, java.lang.String... args)
RestDefinitionVariableType	setComments(java.lang.String value, java.lang.String... args)
RestDefinitionVariableType	setCommonName(java.lang.String value, java.lang.String... args)
RestDefinitionVariableType	setFormat(java.lang.String value, java.lang.String... args)
RestDefinitionVariableType	setType(java.lang.String 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, 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

Data types for the ReST variables.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Data types for the ReST variables.

LIST_BOOLEAN

public static final java.lang.String LIST_BOOLEAN

RestDefinitionVariableType: boolean

See Also:

Constant Field Values

LIST_BYTE

public static final java.lang.String LIST_BYTE

RestDefinitionVariableType: byte

See Also:

Constant Field Values

LIST_DATE

public static final java.lang.String LIST_DATE

RestDefinitionVariableType: date

See Also:

Constant Field Values

LIST_DATE_TIME

public static final java.lang.String LIST_DATE_TIME

RestDefinitionVariableType: dateTime

See Also:

Constant Field Values

LIST_DOUBLE

public static final java.lang.String LIST_DOUBLE

RestDefinitionVariableType: double

See Also:

Constant Field Values

LIST_FILE

public static final java.lang.String LIST_FILE

RestDefinitionVariableType: file

See Also:

Constant Field Values

LIST_FLOAT

public static final java.lang.String LIST_FLOAT

RestDefinitionVariableType: float

See Also:

Constant Field Values

LIST_INTEGER

public static final java.lang.String LIST_INTEGER

RestDefinitionVariableType: integer

See Also:

Constant Field Values

LIST_LONG

public static final java.lang.String LIST_LONG

RestDefinitionVariableType: long

See Also:

Constant Field Values

LIST_PASSWORD

public static final java.lang.String LIST_PASSWORD

RestDefinitionVariableType: password

See Also:

Constant Field Values

LIST_STRING

public static final java.lang.String LIST_STRING

RestDefinitionVariableType: string

See Also:

Constant Field Values

Constructor Detail

RestDefinitionVariableType

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

Throws:

java.lang.Exception

getComments

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

setComments

@Nonnull
public RestDefinitionVariableType setComments(java.lang.String value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

getCommonName

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

setCommonName

@Nonnull
public RestDefinitionVariableType setCommonName(java.lang.String value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getFormat

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

setFormat

@Nonnull
public RestDefinitionVariableType setFormat(java.lang.String value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getType

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

setType

@Nonnull
public RestDefinitionVariableType setType(java.lang.String value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

create

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