com.aspc.DBObj.Help

Class DBHelpPermission

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.ACL.DBPermission

com.aspc.DBObj.Help.DBHelpPermission

All Implemented Interfaces:

SecondaryCacheGroup

public class DBHelpPermission
extends DBPermission

Control access to a help item.

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 Control access to a help item
static java.lang.String	DBCLASS_NAME Control access to a help item

Fields inherited from class com.aspc.DBObj.ACL.DBPermission

TYPE_CREATE, TYPE_DELETE, TYPE_FULL, TYPE_MODIFY, TYPE_READ

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected ValidationError	extValidateField(DBField field, ValidationList list) You can have two permissions for the same user/group.
DBHelpItem	findHelpItem(java.lang.String... args) The link to the Actual Help Item.
DBHelpItem	getHelpItem(java.lang.String... args)
static java.lang.Boolean	hasCreateAccess(DBHelpItem helpItem, FldParams params)
static java.lang.Boolean	hasDeleteAccess(DBHelpItem helpItem, FldParams params)
static java.lang.Boolean	hasFullAccess(DBHelpItem helpItem, FldParams params)
static java.lang.Boolean	hasModifyAccess(DBHelpItem helpItem, FldParams params)
static java.lang.Boolean	hasReadAccess(DBHelpItem helpItem, FldParams params)
DBHelpPermission	setHelpItem(com.aspc.dal.dbobj.help.DBHelpItem value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.ACL.DBPermission

eventDataLoaded, eventFieldUpdated, extFixUp, findCreateAccess, findDeleteAccess, findFullControlAccess, findKey, findModifyAccess, findPermissionedContact, findReadAccess, getCreateAccess, getDeleteAccess, getExpiryTS, getFullControlAccess, getID, getModifyAccess, getPermissionedContact, getReadAccess, getType, iHasAccess, makeQuery, setCreateAccess, setDeleteAccess, setExpiryTS, setFullControlAccess, setID, setModifyAccess, setPermissionedContact, setReadAccess

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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, 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

Control access to a help item

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Control access to a help item

Constructor Detail

DBHelpPermission

public DBHelpPermission(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

getHelpItem

@CheckReturnValue
 @Nullable
public DBHelpItem getHelpItem(java.lang.String... args)

findHelpItem

@CheckReturnValue
 @Nonnull
public final DBHelpItem findHelpItem(java.lang.String... args)
                                                          throws NotFoundException

The link to the Actual Help Item.

--> DBHelpItem (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

help item permission

Throws:

NotFoundException - DBHelpItem was not found

setHelpItem

@Nonnull
public DBHelpPermission setHelpItem(com.aspc.dal.dbobj.help.DBHelpItem value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

extValidateField

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

You can have two permissions for the same user/group.

Overrides:

extValidateField in class DBObject

Parameters:

field - the field

list - the list

Returns:

the validation item

Throws:

java.lang.Exception - a serious problem

hasReadAccess

public static java.lang.Boolean hasReadAccess(DBHelpItem helpItem,
                                              FldParams params)
                                       throws java.lang.Exception

Parameters:

helpItem - the item

params - the parameters

Returns:

true if can read

Throws:

java.lang.Exception - a serious problem

hasModifyAccess

public static java.lang.Boolean hasModifyAccess(DBHelpItem helpItem,
                                                FldParams params)
                                         throws java.lang.Exception

Parameters:

helpItem - the item

params - the parameters

Returns:

true if can modify

Throws:

java.lang.Exception - a serious problem

hasDeleteAccess

public static java.lang.Boolean hasDeleteAccess(DBHelpItem helpItem,
                                                FldParams params)
                                         throws java.lang.Exception

Parameters:

helpItem - the item

params - the parameters

Returns:

true if can delete

Throws:

java.lang.Exception - a serious problem

hasCreateAccess

public static java.lang.Boolean hasCreateAccess(DBHelpItem helpItem,
                                                FldParams params)
                                         throws java.lang.Exception

Parameters:

helpItem - the item

params - the parameters

Returns:

true if can create

Throws:

java.lang.Exception - a serious problem

hasFullAccess

public static java.lang.Boolean hasFullAccess(DBHelpItem helpItem,
                                              FldParams params)
                                       throws java.lang.Exception

Parameters:

helpItem - the item

params - the parameters

Returns:

true if full access.

Throws:

java.lang.Exception - a serious problem