Class OrpheusTableOptions

Namespace

OrpheusCore

Assembly

OrpheusCore.dll

Represents IOrpheusTable options, which can be used to instantiate a table.

public class OrpheusTableOptions : IOrpheusTableOptions

Inheritance

object

OrpheusTableOptions

Implements

IOrpheusTableOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OrpheusTableOptions()

Initializes a new instance of the OrpheusTableOptions class.

public OrpheusTableOptions()

Properties

Database

public IOrpheusDatabase Database { get; set; }

Property Value

IOrpheusDatabase

Database the table belongs to.

KeyFields

public List<IOrpheusTableKeyField> KeyFields { get; set; }

Property Value

List<IOrpheusTableKeyField>

List of the table's key fields. IOrpheusTableKeyField

MasterTable

public IOrpheusTable MasterTable { get; set; }

Property Value

IOrpheusTable

Optional. A master table that this table is associated with.

MasterTableKeyFields

public List<IOrpheusTableKeyField> MasterTableKeyFields { get; set; }

Property Value

List<IOrpheusTableKeyField>

List of the master table's keys (if master table is defined). These are being used to support a master-detail relationship.

MasterTableName

public string MasterTableName { get; set; }

Property Value

string

Optional. A master table that this table is associated with.

ModelType

[IgnoreDataMember]
public Type ModelType { get; set; }

Property Value

Type

Table's model type.

TableName

public string TableName { get; set; }

Property Value

string

Table's name.

Methods

AddKeyField(string, bool, bool, Func<string>)

Creates a new key field.

public void AddKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func<string> keySQLUpdate = null)

Parameters

name string

Field name

isAutoGenerated bool

Auto generate flag

isDBGenerated bool

DB generated flag

keySQLUpdate Func<string>

Function to return a custom SQL when updating the field value

AddMasterKeyField(string, bool, bool, Func<string>)

Creates a new master key field

public void AddMasterKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func<string> keySQLUpdate = null)

Parameters

name string

Field name

isAutoGenerated bool

Auto generate flag

isDBGenerated bool

DB generated flag

keySQLUpdate Func<string>

Function to return a custom SQL when updating the field value