Class TableRight
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Inherited Members
Namespace: SuperOffice.CRM.Security
Assembly: SoCore.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/10.3.0.0")]
public class TableRight : GenericRight
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
Constructors
TableRight()
Creates a blank table right with no rights.
Declaration
public TableRight()
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
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 |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
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 |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
Fields
_mask
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
[DataMember(Name = "Mask")]
protected ETableRight _mask
Field Value
Type | Description |
---|---|
ETableRight |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
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
Type | Description |
---|---|
bool |
Overrides
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
HasDelete
Returns true if the ETableRight.Delete permission is active.
Declaration
public bool HasDelete { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
HasInsert
Returns true if the ETableRight.Insert permission is active.
Declaration
public bool HasInsert { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
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
Type | Description |
---|---|
bool |
Overrides
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
HasRead
Returns true if the ETableRight.Read or ETableRight.FilteredRead permission is active.
Declaration
public bool HasRead { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
HasReadFiltered
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public bool HasReadFiltered { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
HasUpdate
Returns true if the ETableRight.Update or ETableRight.RestrictedUpdate permission is active.
Declaration
public bool HasUpdate { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
IgnoreReason
Should the reason be ignored?
Declaration
protected override bool IgnoreReason { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
IsUpdateRestricted
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public bool IsUpdateRestricted { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
Mask
Returns the bitflag of permissions.
Declaration
public ETableRight Mask { get; }
Property Value
Type | Description |
---|---|
ETableRight |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
Methods
Add(ETableRight, ETableRight)
Perform a logical or operation between the two rights.
Declaration
public static ETableRight Add(ETableRight r1, ETableRight r2)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | r1 | First Right |
ETableRight | r2 | Second Right |
Returns
Type | Description |
---|---|
ETableRight | The resulting right |
Remarks
The operation implements the rules required for ETableRight.
And(ETableRight, ETableRight)
Perform a logical And operation between the two rights.
Declaration
public static ETableRight And(ETableRight r1, ETableRight r2)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | r1 | First Right |
ETableRight | r2 | Second Right |
Returns
Type | Description |
---|---|
ETableRight | The resulting right |
Remarks
The operation implements the rules required for ETableRight.
CanDelete(ETableRight)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public static bool CanDelete(ETableRight observed)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | observed |
Returns
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
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 |
---|---|
bool | True when any of the flags are set |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
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 |
---|---|
bool | True when all the flags are set |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
CanInsert(ETableRight)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public static bool CanInsert(ETableRight observed)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | observed |
Returns
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
CanRead(ETableRight)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public static bool CanRead(ETableRight observed)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | observed |
Returns
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
CanUpdate(ETableRight)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public static bool CanUpdate(ETableRight observed)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | observed |
Returns
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
CanUpdateSome(ETableRight)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public static bool CanUpdateSome(ETableRight observed)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | observed |
Returns
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
DemandAllRights(ETableRight)
Test the permissions and throw a SoSentryException if not all of the permissions are available. CanDoAll(ETableRight)
Declaration
public void DemandAllRights(ETableRight right)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | right | Bitflag of permissions |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
DemandRight(ETableRight)
Test the permissions and throw a SoSentryException if none of the permissions are available. CanDo(ETableRight)
Declaration
public void DemandRight(ETableRight right)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | right | Bitflag of permissions |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
HasAllRightBits(ETableRight, ETableRight)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public static bool HasAllRightBits(ETableRight observed, ETableRight required)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | observed | |
ETableRight | required |
Returns
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
HasSomeRightBits(ETableRight, ETableRight)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public static bool HasSomeRightBits(ETableRight observed, ETableRight required)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | observed | |
ETableRight | required |
Returns
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
IsReadFiltered(ETableRight)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public static bool IsReadFiltered(ETableRight observed)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | observed |
Returns
Type | Description |
---|---|
bool |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
Or(ETableRight, ETableRight)
Perform a logical Or operation between the two rights.
Declaration
public static ETableRight Or(ETableRight r1, ETableRight r2)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | r1 | First Right |
ETableRight | r2 | Second Right |
Returns
Type | Description |
---|---|
ETableRight | The resulting right |
Remarks
The operation implements the rules required for ETableRight.
RawAnd(TableRight)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public TableRight RawAnd(TableRight right)
Parameters
Type | Name | Description |
---|---|---|
TableRight | right |
Returns
Type | Description |
---|---|
TableRight |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
Subtract(ETableRight, ETableRight)
Perform a logical And operation between the two rights.
Declaration
public static ETableRight Subtract(ETableRight r1, ETableRight r2)
Parameters
Type | Name | Description |
---|---|---|
ETableRight | r1 | First Right |
ETableRight | r2 | Second Right |
Returns
Type | Description |
---|---|
ETableRight | The resulting right |
Remarks
The operation implements the rules required for ETableRight. This can be logically illustrated as <c>r1 & ~r2</c>.
ToString()
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
ToString(string)
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Declaration
public string ToString(string prefix)
Parameters
Type | Name | Description |
---|---|---|
string | prefix |
Returns
Type | Description |
---|---|
string |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
Operators
operator &(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
Type | Name | Description |
---|---|---|
TableRight | f1 | |
TableRight | f2 |
Returns
Type | Description |
---|---|
TableRight |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.
operator |(TableRight, TableRight)
Combine two table-rights into one using logical OR.
Declaration
public static TableRight operator |(TableRight f1, TableRight f2)
Parameters
Type | Name | Description |
---|---|---|
TableRight | f1 | |
TableRight | f2 |
Returns
Type | Description |
---|---|
TableRight | New right with combined mask and reason |
Remarks
Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.