com.aspc.cms.rest

Class RestDefinitionVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.rest.RestDefinitionVariable

All Implemented Interfaces:

SecondaryCacheGroup

public class RestDefinitionVariable
extends DBObject

ReST variable validation and defaults.

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 java.lang.String	ATTRIBUTE_PARAMETER
static GlobalId	DBCLASS_GID ReST variable validation and defaults.
static java.lang.String	DBCLASS_NAME ReST variable validation and defaults.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestDefinitionVariable(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
void	checkValue(WebClient client, Method method)
static RestDefinitionVariable	create(MutableDataSource mds) Make a new instance of this class.
protected void	extCopy(DBObject target) Additional functionality when an object is copied.
protected void	extFixUp() The extended fix up routine
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
RestDefinition	findDefinition(java.lang.String... args) The ReST definition.
static RestDefinitionVariable	findKey(DataSource ds, int key) Find the target for this class by the primary key
RestDefinitionVariableLocation	findLocation(java.lang.String... args) The location of the variable.
RestDefinitionVariableType	findType(java.lang.String... args) The variable type.
DBMessage	findValidationMessage(java.lang.String... args) The validation message.
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getConfig(java.lang.String... args)
RestDefinition	getDefinition(java.lang.String... args)
java.lang.String	getDescription(Method method)
java.lang.String	getDescriptionDELETERaw(java.lang.String... args)
java.lang.String	getDescriptionGETRaw(java.lang.String... args)
java.lang.String	getDescriptionHTML(java.lang.String... args)
java.lang.String	getDescriptionPOSTRaw(java.lang.String... args)
java.lang.String	getDescriptionPUTRaw(java.lang.String... args)
java.lang.String[]	getFullList()
int	getID(java.lang.String... args)
RestDefinitionVariableLocation	getLocation(java.lang.String... args)
java.lang.String	getObsoletePathRegex(java.lang.String... args) Deprecated.
java.lang.String	getParseJS(java.lang.String... args)
int	getPathGroup(java.lang.String... args)
java.lang.String	getSanityBadValues(java.lang.String... args)
java.lang.String	getSanityGoodValues(java.lang.String... args)
RestDefinitionVariableType	getType(java.lang.String... args)
DBMessage	getValidationMessage(java.lang.String... args)
java.lang.String	getValidationRegex(java.lang.String... args)
java.lang.String	getValue(WebClient client)
java.lang.String[]	getValueList(WebClient client)
boolean	isApplicableTo(Method method)
boolean	isApplicableToDELETERaw(java.lang.String... args)
boolean	isApplicableToGETRaw(java.lang.String... args)
boolean	isApplicableToPOSTRaw(java.lang.String... args)
boolean	isApplicableToPUTRaw(java.lang.String... args)
boolean	isArray(java.lang.String... args)
boolean	isFinalFg(java.lang.String... args)
boolean	isFulllist(java.lang.String... args)
boolean	isPathVariable() Is this a path variable.
boolean	isRequired(Method method)
boolean	isRequiredDELETE(java.lang.String... args)
boolean	isRequiredDELETERaw(java.lang.String... args)
boolean	isRequiredGET(java.lang.String... args)
boolean	isRequiredGETRaw(java.lang.String... args)
boolean	isRequiredPOST(java.lang.String... args)
boolean	isRequiredPOSTRaw(java.lang.String... args)
boolean	isRequiredPUT(java.lang.String... args)
boolean	isRequiredPUTRaw(java.lang.String... args)
FileUpload	makeFile(WebClient client)
FileUpload[]	makeFileList(WebClient client)
static DBQuery<RestDefinitionVariable>	makeQuery(DataSource ds) Make a new QUERY for this class.
java.lang.String	parseSQL(java.lang.String rawSQL, WebClient client)
RestDefinitionVariable	setApplicableToDELETERaw(boolean value, java.lang.String... args)
RestDefinitionVariable	setApplicableToGETRaw(boolean value, java.lang.String... args)
RestDefinitionVariable	setApplicableToPOSTRaw(boolean value, java.lang.String... args)
RestDefinitionVariable	setApplicableToPUTRaw(boolean value, java.lang.String... args)
RestDefinitionVariable	setArray(boolean value, java.lang.String... args)
RestDefinitionVariable	setCode(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setConfig(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setDefaultValue(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setDefinition(com.aspc.dal.cms.rest.RestDefinition value, java.lang.String... args)
RestDefinitionVariable	setDescriptionDELETERaw(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setDescriptionGETRaw(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setDescriptionHTML(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setDescriptionPOSTRaw(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setDescriptionPUTRaw(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setFinalFg(boolean value, java.lang.String... args)
RestDefinitionVariable	setFulllist(boolean value, java.lang.String... args)
RestDefinitionVariable	setID(int value, java.lang.String... args)
RestDefinitionVariable	setLocation(com.aspc.dal.cms.rest.RestDefinitionVariableLocation value, java.lang.String... args)
RestDefinitionVariable	setObsoletePathRegex(java.lang.String value, java.lang.String... args) Deprecated.
RestDefinitionVariable	setParseJS(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setPathGroup(int value, java.lang.String... args)
RestDefinitionVariable	setRequired(boolean value, java.lang.String... args)
RestDefinitionVariable	setRequiredDELETERaw(boolean value, java.lang.String... args)
RestDefinitionVariable	setRequiredGETRaw(boolean value, java.lang.String... args)
RestDefinitionVariable	setRequiredPOSTRaw(boolean value, java.lang.String... args)
RestDefinitionVariable	setRequiredPUTRaw(boolean value, java.lang.String... args)
RestDefinitionVariable	setSanityBadValues(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setSanityGoodValues(java.lang.String value, java.lang.String... args)
RestDefinitionVariable	setType(com.aspc.dal.cms.rest.RestDefinitionVariableType value, java.lang.String... args)
RestDefinitionVariable	setValidationMessage(com.aspc.dal.message.DBMessage value, java.lang.String... args)
RestDefinitionVariable	setValidationRegex(java.lang.String value, java.lang.String... args)
java.lang.String	toString() The description.

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, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, 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, 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 variable validation and defaults.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

ReST variable validation and defaults.

ATTRIBUTE_PARAMETER

public static final java.lang.String ATTRIBUTE_PARAMETER

See Also:

Constant Field Values

Constructor Detail

RestDefinitionVariable

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

Throws:

java.lang.Exception

isApplicableToDELETERaw

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

setApplicableToDELETERaw

@Nonnull
public RestDefinitionVariable setApplicableToDELETERaw(boolean value,
                                                                java.lang.String... args)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

isApplicableToGETRaw

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

setApplicableToGETRaw

@Nonnull
public RestDefinitionVariable setApplicableToGETRaw(boolean value,
                                                             java.lang.String... args)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

isApplicableToPOSTRaw

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

setApplicableToPOSTRaw

@Nonnull
public RestDefinitionVariable setApplicableToPOSTRaw(boolean value,
                                                              java.lang.String... args)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

isApplicableToPUTRaw

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

setApplicableToPUTRaw

@Nonnull
public RestDefinitionVariable setApplicableToPUTRaw(boolean value,
                                                             java.lang.String... args)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

isArray

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

setArray

@Nonnull
public RestDefinitionVariable setArray(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getCode

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

setCode

@Nonnull
public RestDefinitionVariable setCode(@MatchesPattern(value="[$a-zA-Z]{1}[a-zA-Z0-9_]*")
                                               java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getConfig

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

setConfig

@Nonnull
public RestDefinitionVariable setConfig(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

setDefaultValue

@Nonnull
public RestDefinitionVariable setDefaultValue(java.lang.String value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

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 RestDefinitionVariable setDefinition(com.aspc.dal.cms.rest.RestDefinition value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getDescriptionDELETERaw

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

setDescriptionDELETERaw

@Nonnull
public RestDefinitionVariable setDescriptionDELETERaw(java.lang.String value,
                                                               java.lang.String... args)
                                                        throws java.lang.Exception

Throws:

java.lang.Exception

getDescriptionGETRaw

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

setDescriptionGETRaw

@Nonnull
public RestDefinitionVariable setDescriptionGETRaw(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 RestDefinitionVariable setDescriptionHTML(java.lang.String value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getDescriptionPOSTRaw

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

setDescriptionPOSTRaw

@Nonnull
public RestDefinitionVariable setDescriptionPOSTRaw(java.lang.String value,
                                                             java.lang.String... args)
                                                      throws java.lang.Exception

Throws:

java.lang.Exception

getDescriptionPUTRaw

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

setDescriptionPUTRaw

@Nonnull
public RestDefinitionVariable setDescriptionPUTRaw(java.lang.String value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

isFinalFg

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

setFinalFg

@Nonnull
public RestDefinitionVariable setFinalFg(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

isFulllist

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

setFulllist

@Nonnull
public RestDefinitionVariable setFulllist(boolean value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getLocation

@CheckReturnValue
 @Nullable
public RestDefinitionVariableLocation getLocation(java.lang.String... args)

findLocation

@CheckReturnValue
 @Nonnull
public final RestDefinitionVariableLocation findLocation(java.lang.String... args)
                                                                              throws NotFoundException

The location of the variable.

--> RestDefinitionVariableLocation (String, Searchable)

Parameters:

args - the optional arguments

Returns:

RestDefinitionVariableLocation

Throws:

NotFoundException - RestDefinitionVariableLocation was not found

setLocation

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

Throws:

java.lang.Exception

getObsoletePathRegex

@Deprecated
 @CheckReturnValue
 @Nonnull
public java.lang.String getObsoletePathRegex(java.lang.String... args)

Deprecated.

setObsoletePathRegex

@Deprecated
 @Nonnull
public RestDefinitionVariable setObsoletePathRegex(java.lang.String value,
                                                                         java.lang.String... args)
                                                                  throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getParseJS

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

setParseJS

@Nonnull
public RestDefinitionVariable setParseJS(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getPathGroup

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

setPathGroup

@Nonnull
public RestDefinitionVariable setPathGroup(int value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

setRequired

@Nonnull
public RestDefinitionVariable setRequired(boolean value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

isRequiredDELETE

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

isRequiredDELETERaw

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

setRequiredDELETERaw

@Nonnull
public RestDefinitionVariable setRequiredDELETERaw(boolean value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

isRequiredGET

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

isRequiredGETRaw

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

setRequiredGETRaw

@Nonnull
public RestDefinitionVariable setRequiredGETRaw(boolean value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

isRequiredPOST

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

isRequiredPOSTRaw

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

setRequiredPOSTRaw

@Nonnull
public RestDefinitionVariable setRequiredPOSTRaw(boolean value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

isRequiredPUT

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

isRequiredPUTRaw

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

setRequiredPUTRaw

@Nonnull
public RestDefinitionVariable setRequiredPUTRaw(boolean value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSanityBadValues

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

setSanityBadValues

@Nonnull
public RestDefinitionVariable setSanityBadValues(java.lang.String value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSanityGoodValues

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

setSanityGoodValues

@Nonnull
public RestDefinitionVariable setSanityGoodValues(java.lang.String value,
                                                           java.lang.String... args)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public RestDefinitionVariableType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final RestDefinitionVariableType findType(java.lang.String... args)
                                                                      throws NotFoundException

The variable type.

--> RestDefinitionVariableType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

RestDefinitionVariableType

Throws:

NotFoundException - RestDefinitionVariableType was not found

setType

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

Throws:

java.lang.Exception

getValidationMessage

@CheckReturnValue
 @Nullable
public DBMessage getValidationMessage(java.lang.String... args)

findValidationMessage

@CheckReturnValue
 @Nonnull
public final DBMessage findValidationMessage(java.lang.String... args)
                                                                  throws NotFoundException

The validation message.

--> DBMessage (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Message

Throws:

NotFoundException - DBMessage was not found

setValidationMessage

@Nonnull
public RestDefinitionVariable setValidationMessage(com.aspc.dal.message.DBMessage value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

getValidationRegex

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

setValidationRegex

@Nonnull
public RestDefinitionVariable setValidationRegex(java.lang.String value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

create

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

extCopy

@OverridingMethodsMustInvokeSuper
protected void extCopy(@Nonnull
                                                         DBObject target)
                                                  throws java.lang.Exception

Description copied from class: DBObject

Additional functionality when an object is copied.

Overrides:

extCopy in class DBObject

Parameters:

target - the target object

Throws:

java.lang.Exception - A serious problem

extPreValidate

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

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

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

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

getFullList

public java.lang.String[] getFullList()

isPathVariable

public boolean isPathVariable()

Is this a path variable.

Returns:

TRUE if a path variable.

getValueList

public java.lang.String[] getValueList(WebClient client)
                                throws ExceptionResponse

Throws:

ExceptionResponse

makeFile

public FileUpload makeFile(WebClient client)
                    throws ExceptionResponse

Throws:

ExceptionResponse

makeFileList

public FileUpload[] makeFileList(WebClient client)
                          throws ExceptionResponse

Throws:

ExceptionResponse

getValue

public java.lang.String getValue(WebClient client)

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Description copied from class: DBObject

The description.

Overrides:

toString in class DBObject

Returns:

The description

parseSQL

public java.lang.String parseSQL(java.lang.String rawSQL,
                                 WebClient client)
                          throws java.lang.Exception

Throws:

java.lang.Exception

extFixUp

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

Description copied from class: DBObject

The extended fix up routine

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

checkValue

public void checkValue(WebClient client,
                       Method method)
                throws ExceptionResponse

Throws:

ExceptionResponse

isRequired

public boolean isRequired(Method method)

isApplicableTo

public boolean isApplicableTo(Method method)

getDescription

public java.lang.String getDescription(Method method)