Class CapabilitySetService

Namespace

Dynamicweb.CoreUI.CapabilityControl

Assembly

Dynamicweb.CoreUI.dll

public abstract class CapabilitySetService : ICacheStorage<int, HashSet<CapabilitySetAccess>>, ICacheStorage<int>, ICacheStorage

Inheritance

object

CapabilitySetService

Implements

ICacheStorage<int, HashSet<CapabilitySetAccess>>

ICacheStorage<int>

ICacheStorage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Info

Represents the Cache information

public abstract CacheInformation Info { get; }

Property Value

CacheInformation

Methods

ClearCache()

Clears Cache

public abstract void ClearCache()

ClearCache(IEnumerable<int>)

Clears Cache by user group ids collection

public abstract void ClearCache(IEnumerable<int> keys)

Parameters

keys IEnumerable<int>

The collection of user group ids

ClearCache(int)

Clears Cache by user group id

public abstract void ClearCache(int key)

Parameters

key int

The user group id

CurrentUserHasCapabilitySet(CapabilitySetKey)

Checks whether the current user has access to use the specified capability set.

public abstract bool CurrentUserHasCapabilitySet(CapabilitySetKey capabilitySetKey)

Parameters

capabilitySetKey CapabilitySetKey

The capability set key

Returns

bool

CurrentUserHasCapabilitySets(IEnumerable<CapabilitySetKey>)

Checks whether the current user has access to use the specified collection of capability sets.

public abstract bool CurrentUserHasCapabilitySets(IEnumerable<CapabilitySetKey> capabilitySetKeys)

Parameters

capabilitySetKeys IEnumerable<CapabilitySetKey>

Capability set keys

Returns

bool

GetCapabilitySetAccess(int, CapabilitySetKey)

Gets capability set access data

public abstract CapabilitySetAccess? GetCapabilitySetAccess(int userGroupId, CapabilitySetKey key)

Parameters

userGroupId int

User group id

key CapabilitySetKey

Capability set key

Returns

CapabilitySetAccess

GetCapabilitySetAccesses(IEnumerable<CapabilitySetKey>)

Gets all capability set access data for specified capability set keys

public abstract HashSet<CapabilitySetAccess> GetCapabilitySetAccesses(IEnumerable<CapabilitySetKey> keys)

Parameters

keys IEnumerable<CapabilitySetKey>

Capability set keys

Returns

HashSet<CapabilitySetAccess>

RestrictCapabilitySet(int, CapabilitySet)

Restricts access to capability set.

public abstract void RestrictCapabilitySet(int userGroupId, CapabilitySet capabilitySet)

Parameters

userGroupId int

User group id

capabilitySet CapabilitySet

Capability set

SetCacheType<TObjectCache>()

Sets the Cache type

public abstract void SetCacheType<TObjectCache>() where TObjectCache : ServiceCache<int, HashSet<CapabilitySetAccess>>

Type Parameters

TObjectCache

UnrestrictCapabilitySet(int, CapabilitySet)

Remove access restriction for capability set.

public abstract void UnrestrictCapabilitySet(int userGroupId, CapabilitySet capabilitySet)

Parameters

userGroupId int

User group id

capabilitySet CapabilitySet

Capability set

UserHasCapabilitySet(int, CapabilitySetKey)

Checks whether the user has access to use the specified capability set.

public abstract bool UserHasCapabilitySet(int userId, CapabilitySetKey capabilitySetKey)

Parameters

userId int

User id

capabilitySetKey CapabilitySetKey

The capability set key

Returns

bool

UserHasCapabilitySets(int, IEnumerable<CapabilitySetKey>)

Checks whether the user has access to use the specified collection of capability sets.

public abstract bool UserHasCapabilitySets(int userId, IEnumerable<CapabilitySetKey> capabilitySetKeys)

Parameters

userId int

User id

capabilitySetKeys IEnumerable<CapabilitySetKey>

Capability set keys

Returns

bool