com.aspc.cms.permission

Class SiteRoleMap

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.permission.SitePermissionMap

com.aspc.cms.permission.SiteRoleMap

All Implemented Interfaces:

SecondaryCacheGroup

public class SiteRoleMap
extends SitePermissionMap

Site Role Map.

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

Since:

06 November 2013

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 Site Role Map
static java.lang.String	DBCLASS_NAME Site Role Map

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
SiteRoleMap(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
protected void	extAutoEnterCreate() Extend this method to add functionality when a new DBObject is created. You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected void	extPreValidateDelete() OVERRIDE To add functionality to before validation is called.
protected ValidationError	extValidateField(DBField field, ValidationList list) You can have two permissions for the same user/group.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
static java.lang.Boolean	hasCreateAccess(Site site) A CREATE permission for this site
static java.lang.Boolean	hasDeleteAccess(Site site) A DELETE permission for this site
static java.lang.Boolean	hasFullAccess(Site site) A Full Access permission for this site
static java.lang.Boolean	hasModifyAccess(Site site) A MODIFY permission for this site
boolean	isAuthor(java.lang.String... args)
boolean	isDesigner(java.lang.String... args)
boolean	isFullAccess(java.lang.String... args)
boolean	isPublisher(java.lang.String... args)
SiteRoleMap	setAuthor(boolean value, java.lang.String... args)
SiteRoleMap	setDesigner(boolean value, java.lang.String... args)
SiteRoleMap	setFullAccess(boolean value, java.lang.String... args)
SiteRoleMap	setPublisher(boolean value, java.lang.String... args)

Methods inherited from class com.aspc.cms.permission.SitePermissionMap

extPreDeleteRecord, extPreSaveRecord, findKey, findPermissionedContact, findSite, getID, getPermissionedContact, getSite, hasAccess, makeQuery, setID, setPermissionedContact, setSite

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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

Site Role Map

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Site Role Map

Constructor Detail

SiteRoleMap

public SiteRoleMap(DBClass theClass,
                   DataSource dataSource)
            throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

isAuthor

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

setAuthor

@Nonnull
public SiteRoleMap setAuthor(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isDesigner

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

setDesigner

@Nonnull
public SiteRoleMap setDesigner(boolean value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

isFullAccess

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

setFullAccess

@Nonnull
public SiteRoleMap setFullAccess(boolean value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isPublisher

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

setPublisher

@Nonnull
public SiteRoleMap setPublisher(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Description copied from class: DBObject

Performs additional validations on this record. OVERRIDE this method to add additional validations to a record.
The MutableDataSource is in READONLY mode at this stage.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extAutoEnterCreate

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

Description copied from class: DBObject

Extend this method to add functionality when a new DBObject is created.
You may need to create a FldParams, and setIsAutoEntered(true) so that system does not misunderstand that this object is changed by user.

Overrides:

extAutoEnterCreate 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

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

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to validate

list - The validation list

Returns:

The validation ERROR

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 SitePermissionMap

Throws:

java.lang.Exception - a serious problem

extPreValidateDelete

@OverridingMethodsMustInvokeSuper
protected void extPreValidateDelete()
                                                               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 FOR DELETED RECORDS.

Overrides:

extPreValidateDelete in class SitePermissionMap

Throws:

java.lang.Exception - a serious problem

hasModifyAccess

public static java.lang.Boolean hasModifyAccess(Site site)
                                         throws java.lang.Exception

A MODIFY permission for this site

Parameters:

site - The site to check

Returns:

TRUE if OK

Throws:

java.lang.Exception - A serious problem

hasDeleteAccess

public static java.lang.Boolean hasDeleteAccess(Site site)
                                         throws java.lang.Exception

A DELETE permission for this site

Parameters:

site - The site to check

Returns:

TRUE if OK

Throws:

java.lang.Exception - A serious problem

hasCreateAccess

public static java.lang.Boolean hasCreateAccess(Site site)
                                         throws java.lang.Exception

A CREATE permission for this site

Parameters:

site - The site to check

Returns:

TRUE if OK

Throws:

java.lang.Exception - A serious problem

hasFullAccess

public static java.lang.Boolean hasFullAccess(Site site)
                                       throws java.lang.Exception

A Full Access permission for this site

Parameters:

site - The site to check

Returns:

TRUE if OK

Throws:

java.lang.Exception - A serious problem