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

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()

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.

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

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.

FunctionRight(String)

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

Declaration

public FunctionRight(string keyName)

Parameters

Type	Name	Description
String	keyName

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.

Fields

_active

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".

Declaration

protected bool _active

Field Value

Type	Description
Boolean

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.

_description

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".

Declaration

protected string _description

Field Value

Type	Description
String

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.

_key

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".

Declaration

protected string _key

Field Value

Type	Description
String

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.

_name

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".

Declaration

protected string _name

Field Value

Type	Description
String

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.

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

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.

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

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.

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

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.

IgnoreReason

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".

Declaration

protected override bool IgnoreReason { get; }

Property Value

Type	Description
Boolean

Overrides

GenericRight.IgnoreReason

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.

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

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.

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

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.

Extension Methods

EnumUtil.MapEnums<From, To>(From)

ObjectExtensions.AssignByReflection<T>(T, T)

ObjectExtensions.GraphCopy<T>(T)

Converters.MapEnums<From, To>(From)