com.aspc.message

Class DBMessageVariable

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.message.DBMessageVariable

All Implemented Interfaces:

SecondaryCacheGroup

public class DBMessageVariable
extends DBObject

The variable for use within a message.

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

Since:

8 September 2003

Author:

Nigel Leck

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 The variable for use within a message
static java.lang.String	DBCLASS_NAME The variable for use within a message

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBMessageVariable(DBClass dbClass, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static DBMessageVariable	create(MutableDataSource mds) Make a new instance of this class.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
static DBMessageVariable	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBMessage	findMessage(java.lang.String... args) The message that these variables are used.
DBMessageVariableType	findType(java.lang.String... args) The type of this message variable.
java.lang.Object	getArg(java.lang.Object[] args) gets the argument from a list of arguments.
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getData(java.lang.String... args)
java.lang.String	getFormat(java.lang.String... args)
int	getID(java.lang.String... args)
int	getIndex(java.lang.String... args)
DBMessage	getMessage(java.lang.String... args)
DBMessageVariableType	getType(java.lang.String... args)
boolean	isIncludesTags(java.lang.String... args)
java.lang.String	makeHtml(java.lang.Object[] args) make the variable.
java.lang.String	makeHtmlPlugin(java.lang.Object[] args) make the variable.
java.lang.String	makePath(java.lang.Object[] args) make the variable.
static DBQuery<DBMessageVariable>	makeQuery(DataSource ds) Make a new QUERY for this class.
java.lang.String	makeSpecial(java.lang.Object[] args) make the variable.
java.lang.String	makeString(java.lang.Object[] args) make the variable.
java.lang.String	makeText(java.lang.Object[] args) make the variable.
java.lang.String	makeTextPlugin(java.lang.Object[] args) make the variable.
DBMessageVariable	setCode(java.lang.String value, java.lang.String... args)
DBMessageVariable	setData(java.lang.String value, java.lang.String... args)
DBMessageVariable	setFormat(java.lang.String value, java.lang.String... args)
DBMessageVariable	setID(int value, java.lang.String... args)
DBMessageVariable	setIncludesTags(boolean value, java.lang.String... args)
DBMessageVariable	setIndex(int value, java.lang.String... args)
DBMessageVariable	setMessage(com.aspc.dal.message.DBMessage value, java.lang.String... args)
DBMessageVariable	setType(com.aspc.dal.message.DBMessageVariableType 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

The variable for use within a message

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The variable for use within a message

Constructor Detail

DBMessageVariable

public DBMessageVariable(DBClass dbClass,
                         DataSource dataSource)
                  throws java.lang.Exception

Std. DBObject constructor

Parameters:

dbClass - The class

dataSource - The data source for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

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

setID

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

Throws:

java.lang.Exception

getData

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

setData

@Nonnull
public DBMessageVariable setData(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 DBMessageVariable setFormat(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isIncludesTags

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

setIncludesTags

@Nonnull
public DBMessageVariable setIncludesTags(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getIndex

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

setIndex

@Nonnull
public DBMessageVariable setIndex(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getMessage

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

findMessage

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

The message that these variables are used.

--> DBMessage (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Message

Throws:

NotFoundException - DBMessage was not found

setMessage

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

Throws:

java.lang.Exception

getType

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

findType

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

The type of this message variable.

--> DBMessageVariableType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBMessageVariableType

Throws:

NotFoundException - DBMessageVariableType was not found

setType

@Nonnull
public DBMessageVariable setType(com.aspc.dal.message.DBMessageVariableType value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

create

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

makeText

@CheckReturnValue
 @Nonnull
public java.lang.String makeText(@Nullable
                                                             java.lang.Object[] args)
                                                      throws DBMessageVariableException

make the variable.

Parameters:

args - the arguments to use

Returns:

the value.

Throws:

DBMessageVariableException - a problem with the variable.

makeHtml

@CheckReturnValue
 @Nonnull
public java.lang.String makeHtml(@Nullable
                                                             java.lang.Object[] args)
                                                      throws DBMessageVariableException

make the variable.

Parameters:

args - the arguments to use

Returns:

the value.

Throws:

DBMessageVariableException - a problem with the variable.

makePath

@Nonnull
 @CheckReturnValue
public java.lang.String makePath(@Nullable
                                                             java.lang.Object[] args)
                                                      throws DBMessageVariableException

make the variable.

Parameters:

args - the arguments to use

Returns:

the value.

Throws:

DBMessageVariableException - a problem with the variable.

makeSpecial

@Nonnull
 @CheckReturnValue
public java.lang.String makeSpecial(@Nullable
                                                                java.lang.Object[] args)
                                                         throws DBMessageVariableException

make the variable.

Parameters:

args - the arguments to use

Returns:

the value.

Throws:

DBMessageVariableException - a problem with the variable.

makeHtmlPlugin

@Nonnull
 @CheckReturnValue
public java.lang.String makeHtmlPlugin(java.lang.Object[] args)
                                                            throws DBMessageVariableException

make the variable.

Parameters:

args - the arguments to use

Returns:

the value.

Throws:

DBMessageVariableException - a problem with the variable.

makeTextPlugin

@Nonnull
 @CheckReturnValue
public java.lang.String makeTextPlugin(@Nullable
                                                                   java.lang.Object[] args)
                                                            throws DBMessageVariableException

make the variable.

Parameters:

args - the arguments to use

Returns:

the value.

Throws:

DBMessageVariableException - a problem with the variable.

extValidateField

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

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

makeString

@Nonnull
 @CheckReturnValue
public java.lang.String makeString(@Nullable
                                                               java.lang.Object[] args)
                                                        throws DBMessageVariableException

make the variable.

Parameters:

args - the arguments to use

Returns:

the value.

Throws:

DBMessageVariableException - a problem with the variable.

getArg

@Nullable
 @CheckReturnValue
public java.lang.Object getArg(@Nullable
                                                            java.lang.Object[] args)

gets the argument from a list of arguments.

Parameters:

args - the arguments to use

Returns:

the value