com.aspc.workflow

Class DBEventValidationEntitlement

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.workflow.DBEventValidation

com.aspc.workflow.DBEventValidationEntitlement

All Implemented Interfaces:

SecondaryCacheGroup

public class DBEventValidationEntitlement
extends DBEventValidation

The DBEventValidationEntitlement class defines an DBEvent Validation that is based on the current user being a member of the associated DBEntitlement.

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

Since:

15 June, 2004

Author:

Jason McGrath

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 DBEventValidationEntitlement class defines an DBEvent Validation that is based on the current user being a member of the associated DBEntitlement.
static java.lang.String	DBCLASS_NAME The DBEventValidationEntitlement class defines an DBEvent Validation that is based on the current user being a member of the associated DBEntitlement.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBEventValidationEntitlement(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
Entitlement	findEntitlement(java.lang.String... args) The associated entitlement that user must be a member of for this validation to pass.
Entitlement	getEntitlement(java.lang.String... args)
boolean	isComplex() As this is a entitlement validation so it is deemed as non-complex
DBEventValidationEntitlement	setEntitlement(com.aspc.dal.dbobj.contact.Entitlement value, java.lang.String... args)
ValidationItem	validateBaseObject(DBObject base) Validates that the user has access to an Entitlement

Methods inherited from class com.aspc.workflow.DBEventValidation

extValidateField, findKey, findLevel, findMessage, findModuleOption, generateValidationItem, getCondition, getID, getLevel, getMessage, getModuleOption, getSummary, getValidationGroup, isApplicable, makeQuery, setCondition, setID, setLevel, setMessage, setModuleOption, setValidationGroup

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

The DBEventValidationEntitlement class defines an DBEvent Validation that is based on the current user being a member of the associated DBEntitlement.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The DBEventValidationEntitlement class defines an DBEvent Validation that is based on the current user being a member of the associated DBEntitlement.

Constructor Detail

DBEventValidationEntitlement

public DBEventValidationEntitlement(DBClass def,
                                    DataSource dataSource)
                             throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getEntitlement

@CheckReturnValue
 @Nullable
public Entitlement getEntitlement(java.lang.String... args)

findEntitlement

@CheckReturnValue
 @Nonnull
public final Entitlement findEntitlement(java.lang.String... args)
                                                              throws NotFoundException

The associated entitlement that user must be a member of for this validation to pass.

--> Entitlement (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Entitlement

Throws:

NotFoundException - Entitlement was not found

setEntitlement

@Nonnull
public DBEventValidationEntitlement setEntitlement(com.aspc.dal.dbobj.contact.Entitlement value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

validateBaseObject

public ValidationItem validateBaseObject(DBObject base)
                                  throws java.lang.Exception

Validates that the user has access to an Entitlement

Specified by:

validateBaseObject in class DBEventValidation

Parameters:

base - Base object to validate

Returns:

ValidationItem

Throws:

java.lang.Exception - Exception

isComplex

public boolean isComplex()

As this is a entitlement validation so it is deemed as non-complex

Specified by:

isComplex in class DBEventValidation

Returns:

false