Class TableRight
Wraps a table right together with an explanatory reason.
Code can indicate why access is restricted.
Assembly: SoCore.dll
Syntax
public class TableRight : GenericRight
Constructors
TableRight()
Creates a blank table right with no rights.
Declaration
TableRight(ETableRight)
Create a table right with the given set of permissions.
Declaration
public TableRight(ETableRight right)
Parameters
| Type |
Name |
Description |
| ETableRight |
right |
A bitflag of table permissions
|
TableRight(ETableRight, String)
Create a table right with the given set of permissions and the given reason.
Declaration
public TableRight(ETableRight right, string theReason)
Parameters
| Type |
Name |
Description |
| ETableRight |
right |
Bitflag of table permissions
|
| String |
theReason |
Description of why permissions are restricted
|
Fields
_mask
Declaration
protected ETableRight _mask
Field Value
Properties
HasAll
Returns true when all of Read, Insert, Delete, Update permissions are available.
Filter and RestrictedUpdate permissions are ignored.
Declaration
public override bool HasAll { get; }
Property Value
Overrides
HasDelete
Returns true if the ETableRight.Delete permission is active.
Declaration
public bool HasDelete { get; }
Property Value
HasInsert
Returns true if the ETableRight.Insert permission is active.
Declaration
public bool HasInsert { get; }
Property Value
HasNone
Returns true when no permissions are available. Filter or RestrictedUpdate permissions mean that HasNone would return false.
Declaration
public override bool HasNone { get; }
Property Value
Overrides
HasRead
Returns true if the ETableRight.Read or ETableRight.FilteredRead permission is active.
Declaration
public bool HasRead { get; }
Property Value
HasReadFiltered
Declaration
public bool HasReadFiltered { get; }
Property Value
HasUpdate
Returns true if the ETableRight.Update or ETableRight.RestrictedUpdate permission is active.
Declaration
public bool HasUpdate { get; }
Property Value
IgnoreReason
Declaration
protected override bool IgnoreReason { get; }
Property Value
Overrides
IsUpdateRestricted
Declaration
public bool IsUpdateRestricted { get; }
Property Value
Mask
Returns the bitflag of permissions.
Declaration
public ETableRight Mask { get; }
Property Value
Methods
Add(ETableRight, ETableRight)
Perform a logical or operation between the two rights.
Declaration
public static ETableRight Add(ETableRight r1, ETableRight r2)
Parameters
Returns
And(ETableRight, ETableRight)
Perform a logical And operation between the two rights.
Declaration
public static ETableRight And(ETableRight r1, ETableRight r2)
Parameters
Returns
Remarks
CanDelete(ETableRight)
Declaration
public static bool CanDelete(ETableRight observed)
Parameters
Returns
CanDo(ETableRight)
Returns true when one or more of the given permissions are available.
Declaration
public bool CanDo(ETableRight right)
Parameters
| Type |
Name |
Description |
| ETableRight |
right |
Bitflag of permissions
|
Returns
| Type |
Description |
| Boolean |
True when any of the flags are set
|
CanDoAll(ETableRight)
Returns true when all the given permissions are available.
Declaration
public bool CanDoAll(ETableRight right)
Parameters
| Type |
Name |
Description |
| ETableRight |
right |
Bitflag of permissions
|
Returns
| Type |
Description |
| Boolean |
True when all the flags are set
|
CanInsert(ETableRight)
Declaration
public static bool CanInsert(ETableRight observed)
Parameters
Returns
CanRead(ETableRight)
Declaration
public static bool CanRead(ETableRight observed)
Parameters
Returns
CanUpdate(ETableRight)
Declaration
public static bool CanUpdate(ETableRight observed)
Parameters
Returns
CanUpdateSome(ETableRight)
Declaration
public static bool CanUpdateSome(ETableRight observed)
Parameters
Returns
DemandAllRights(ETableRight)
Declaration
public void DemandAllRights(ETableRight right)
Parameters
| Type |
Name |
Description |
| ETableRight |
right |
Bitflag of permissions
|
DemandRight(ETableRight)
Declaration
public void DemandRight(ETableRight right)
Parameters
| Type |
Name |
Description |
| ETableRight |
right |
Bitflag of permissions
|
HasAllRightBits(ETableRight, ETableRight)
Declaration
public static bool HasAllRightBits(ETableRight observed, ETableRight required)
Parameters
Returns
HasSomeRightBits(ETableRight, ETableRight)
Declaration
public static bool HasSomeRightBits(ETableRight observed, ETableRight required)
Parameters
Returns
IsReadFiltered(ETableRight)
Declaration
public static bool IsReadFiltered(ETableRight observed)
Parameters
Returns
Or(ETableRight, ETableRight)
Perform a logical Or operation between the two rights.
Declaration
public static ETableRight Or(ETableRight r1, ETableRight r2)
Parameters
Returns
RawAnd(TableRight)
Declaration
public TableRight RawAnd(TableRight right)
Parameters
Returns
Subtract(ETableRight, ETableRight)
Perform a logical And operation between the two rights.
Declaration
public static ETableRight Subtract(ETableRight r1, ETableRight r2)
Parameters
Returns
ToString()
Declaration
public override string ToString()
Returns
Overrides
ToString(String)
Declaration
public string ToString(string prefix)
Parameters
| Type |
Name |
Description |
| String |
prefix |
|
Returns
Operators
BitwiseAnd(TableRight, TableRight)
Combine two table-rights into one. Permissions are logically ANDed together, giving us the lowest common denominator results.
Declaration
public static TableRight operator &(TableRight f1, TableRight f2)
Parameters
Returns
BitwiseOr(TableRight, TableRight)
Combine two table-rights into one using logical OR.
Declaration
public static TableRight operator |(TableRight f1, TableRight f2)
Parameters
Returns
| Type |
Description |
| TableRight |
New right with combined mask and reason
|
Extension Methods
EnumUtil.MapEnums<From, To>(From)