Show / Hide Table of Contents

Class FunctionRight

Represents a Function Right together with an description of the function. Function rights typically represent abilities like "can admin users" or "can create private appointments".

Inheritance
Object
GenericRight
ItemRight
FunctionRight
Inherited Members
GenericRight._reason
GenericRight.Reason
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Security
Assembly: SoCore.dll
Syntax
public class FunctionRight : ItemRight
Remarks

Function rights have a descriptive name, a description, and a key. For example: key = "admin-all", name="General Administrator", description="Has access to all maintenance functions."

Usually obtained from the SuperOffice.CRM.Security.RightsFactory rather than created directly by the client.

Constructors

FunctionRight()

Create a blank function-right with no permissions.

Declaration
public FunctionRight()

FunctionRight(Int32)

Create a field right with the given id.

Declaration
public FunctionRight(int id)
Parameters
Type Name Description
Int32 id

Primary key id of the function right

FunctionRight(String)

Create a Function right with the given key name. The description +

Declaration
public FunctionRight(string keyName)
Parameters
Type Name Description
String keyName

Fields

_active

Declaration
protected bool _active
Field Value
Type Description
Boolean

_description

Declaration
protected string _description
Field Value
Type Description
String

_key

Declaration
protected string _key
Field Value
Type Description
String

_name

Declaration
protected string _name
Field Value
Type Description
String

Properties

Description

The human-readable description of the function right. For example: "Able to maintain users", "Allowed to create private appointments"

Declaration
public string Description { get; }
Property Value
Type Description
String

HasAll

Returns true when the right is granted to user. Equivalent to the IsActive property.

Declaration
public override bool HasAll { get; }
Property Value
Type Description
Boolean
Overrides
GenericRight.HasAll

HasNone

Returns true when the right is not granted to the user. Inverse of HasAll property.

Declaration
public override bool HasNone { get; }
Property Value
Type Description
Boolean
Overrides
GenericRight.HasNone

IgnoreReason

Declaration
protected override bool IgnoreReason { get; }
Property Value
Type Description
Boolean
Overrides
GenericRight.IgnoreReason

IsActive

Returns true when the right has been granted to the user. Equivalent to the HasAll property.

Declaration
public override bool IsActive { get; }
Property Value
Type Description
Boolean
Overrides
ItemRight.IsActive

Name

The human-readable name of the function right. For example: "General Administrator", "Allow Mail Merge"

Declaration
public string Name { get; }
Property Value
Type Description
String

Extension Methods

EnumUtil.MapEnums<From, To>(From)
ObjectExtensions.AssignByReflection<T>(T, T)
ObjectExtensions.GraphCopy<T>(T)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Back to top