Class RoleTableInfo

Table 'Role': User roles for role-based security, names and tooltips are in LocaleText. For more information regarding role based security, see http://techdoc.superoffice.com

Inheritance

object

TableInfo

RoleTableInfo

Implements

ICloneable

Inherited Members

TableInfo.ToString()

TableInfo.RegisterFields(params FieldInfo[])

TableInfo.FieldInfoFromSoField(SoField)

TableInfo.Clone()

TableInfo.IsSameTable(TableInfo)

TableInfo.FindField(string)

TableInfo.ProtAll

TableInfo.HashCheckFields

TableInfo.TableName

TableInfo.DbName

TableInfo.IsDictionaryTable

TableInfo.All

TableInfo.this[string]

TableInfo.PrimaryKeyField

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Data

Assembly: SoDataBase.dll

Syntax

[DatabaseTable("Role")]
public class RoleTableInfo : TableInfo, ICloneable

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

Fields

DictionaryTableName

Conceptual name of table Role in the database dictionary: Role

Declaration

public const string DictionaryTableName = "Role"

Field Value

Type	Description
string

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

Properties

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration

public override SoTable Definition { get; }

Property Value

Type	Description
SoTable

Overrides

TableInfo.Definition

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

Deleted

Field 'deleted' in table 'Role': Dictionary type UShort, .NET type: short

1 if role has been deleted (we do not actually delete)

Declaration

public UInt16FieldInfo Deleted { get; }

Property Value

Type	Description
UInt16FieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

DictionaryTableNumber

Table number for table Role in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration

public int DictionaryTableNumber { get; }

Property Value

Type	Description
int

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

EncryptedCheck

Field 'encryptedCheck' in table 'Role': Dictionary type String[255], .NET type: string

Encrypted data, to detect unwanted changes

Declaration

public StringFieldInfo EncryptedCheck { get; }

Property Value

Type	Description
StringFieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

LeftOuterJoin_DataRight_RoleId

Generated left outer join from the primary key RoleId on this table, to DataRight.RoleId.

Declaration

public TargetedLeftOuterJoin<DataRightTableInfo> LeftOuterJoin_DataRight_RoleId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<DataRightTableInfo>

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

LeftOuterJoin_FunctionRightRoleLink_RoleId

Generated left outer join from the primary key RoleId on this table, to FunctionRightRoleLink.RoleId.

Declaration

public TargetedLeftOuterJoin<FunctionRightRoleLinkTableInfo> LeftOuterJoin_FunctionRightRoleLink_RoleId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<FunctionRightRoleLinkTableInfo>

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

LeftOuterJoin_RoleCategory_CrmRole

Generated left outer join from the primary key RoleId on this table, to RoleCategory.CrmRole.

Declaration

public TargetedLeftOuterJoin<RoleCategoryTableInfo> LeftOuterJoin_RoleCategory_CrmRole { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<RoleCategoryTableInfo>

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

LeftOuterJoin_RoleElement_CrmRole

Generated left outer join from the primary key RoleId on this table, to RoleElement.CrmRole.

Declaration

public TargetedLeftOuterJoin<RoleElementTableInfo> LeftOuterJoin_RoleElement_CrmRole { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<RoleElementTableInfo>

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

LeftOuterJoin_RoleWorkflow_CrmRole

Generated left outer join from the primary key RoleId on this table, to RoleWorkflow.CrmRole.

Declaration

public TargetedLeftOuterJoin<RoleWorkflowTableInfo> LeftOuterJoin_RoleWorkflow_CrmRole { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<RoleWorkflowTableInfo>

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

LeftOuterJoin_UserRoleLink_RoleId

Generated left outer join from the primary key RoleId on this table, to UserRoleLink.RoleId.

Declaration

public TargetedLeftOuterJoin<UserRoleLinkTableInfo> LeftOuterJoin_UserRoleLink_RoleId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<UserRoleLinkTableInfo>

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

Name

Field 'name' in table 'Role': Dictionary type String[240], .NET type: string

Visible role name

Declaration

public StringFieldInfo Name { get; }

Property Value

Type	Description
StringFieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

Rank

Field 'rank' in table 'Role': Dictionary type UShort, .NET type: short

Sorting rank of this role in lists

Declaration

public UInt16FieldInfo Rank { get; }

Property Value

Type	Description
UInt16FieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

Registered

Field 'registered' in table 'Role': Dictionary type UtcDateTime, .NET type: DateTime

Registered when

Declaration

public DateTimeFieldInfo Registered { get; }

Property Value

Type	Description
DateTimeFieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

RegisteredAssociateId

Field 'registered_associate_id' in table 'Role': Dictionary type FK, target: Associate, .NET type: int

Registered by whom

Declaration

public Int32FieldInfo RegisteredAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

RegisteredAssociateId_InnerJoin_Associate

Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

RoleId

Field 'Role_id' in table 'Role': Dictionary type PK, .NET type: int

Primary key

Declaration

public Int32FieldInfo RoleId { get; }

Property Value

Type	Description
Int32FieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

RoleType

Field 'roleType' in table 'Role': Dictionary type Enum, .NET type: RoleType

0 = employee, 1 = external user, 2 = anonymous

Declaration

public RoleTypeFieldInfo RoleType { get; }

Property Value

Type	Description
RoleTypeFieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration

[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }

Property Value

Type	Description
SoTable

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

Tooltip

Field 'tooltip' in table 'Role': Dictionary type String[255], .NET type: string

Visible tooltip

Declaration

public StringFieldInfo Tooltip { get; }

Property Value

Type	Description
StringFieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

Updated

Field 'updated' in table 'Role': Dictionary type UtcDateTime, .NET type: DateTime

Last updated when

Declaration

public DateTimeFieldInfo Updated { get; }

Property Value

Type	Description
DateTimeFieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

UpdatedAssociateId

Field 'updated_associate_id' in table 'Role': Dictionary type FK, target: Associate, .NET type: int

Last updated by whom

Declaration

public Int32FieldInfo UpdatedAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

UpdatedAssociateId_InnerJoin_Associate

Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

UpdatedCount

Field 'updatedCount' in table 'Role': Dictionary type UShort, .NET type: short

Number of updates made to this record

Declaration

public UInt16FieldInfo UpdatedCount { get; }

Property Value

Type	Description
UInt16FieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

UseCategories

Field 'use_categories' in table 'Role': Dictionary type Bool, .NET type: short

Override user categories with role categories

Declaration

public UInt16FieldInfo UseCategories { get; }

Property Value

Type	Description
UInt16FieldInfo

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetRoleInfo().

Implements

ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)