Table of Contents

Interface IOrpheusTableOptions

Namespace
OrpheusInterfaces.Core
Assembly
OrpheusInterfaces.dll

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

public interface IOrpheusTableOptions

Properties

Database

Database that the table is a part of.

[IgnoreDataMember]
IOrpheusDatabase Database { get; set; }

Property Value

IOrpheusDatabase

Database that the table is part of

KeyFields

Table's key field(s). Can be more than one to support composite keys.

List<IOrpheusTableKeyField> KeyFields { get; set; }

Property Value

List<IOrpheusTableKeyField>

Table's key fields

MasterTable

Table's master table. To support the master-detail relationship.

[IgnoreDataMember]
IOrpheusTable MasterTable { get; set; }

Property Value

IOrpheusTable

Table's master table

MasterTableKeyFields

Master table's key field(s). Can be more than one to support composite keys.

List<IOrpheusTableKeyField> MasterTableKeyFields { get; set; }

Property Value

List<IOrpheusTableKeyField>

Master table's key field

MasterTableName

Table's master table. To support the master-detail relationship.

string MasterTableName { get; set; }

Property Value

string

Table's master table name

ModelType

Model type.

Type ModelType { get; set; }

Property Value

Type

Table model type

TableName

Table's name.

string TableName { get; set; }

Property Value

string

Table's name

Methods

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

Creates a new key field.

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

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