Interface IOrpheusModuleDefinition

Namespace

OrpheusInterfaces.Core

Assembly

OrpheusInterfaces.dll

The definition/database properties of a module.

public interface IOrpheusModuleDefinition

Properties

Database

Orpheus database.

IOrpheusDatabase Database { get; set; }

Property Value

IOrpheusDatabase

Orpheus Database

DetailTableOptions

List of module's detail table options.

List<IOrpheusTableOptions> DetailTableOptions { get; set; }

Property Value

List<IOrpheusTableOptions>

Module's detail table options

MainTableOptions

Module's main table options.

IOrpheusTableOptions MainTableOptions { get; set; }

Property Value

IOrpheusTableOptions

Module's main table options

Name

Module name.

string Name { get; set; }

Property Value

string

Module name

ReferenceTableOptions

List of module reference tables.

List<IOrpheusTableOptions> ReferenceTableOptions { get; set; }

Property Value

List<IOrpheusTableOptions>

Module's reference table options

Methods

CreateTableOptions()

Creates an instance of OrpheusTableOptions.

IOrpheusTableOptions CreateTableOptions()

Returns

IOrpheusTableOptions

An IOrpheusTableOptions instance

CreateTableOptions(string, Type)

Creates an instance of OrpheusTableOptions.

IOrpheusTableOptions CreateTableOptions(string tableName, Type modelType)

Parameters

tableName string

modelType Type

Returns

IOrpheusTableOptions

An IOrpheusTableOptions instance

CreateTableOptions(Type)

Creates an instance of OrpheusTableOptions.

IOrpheusTableOptions CreateTableOptions(Type modelType)

Parameters

modelType Type

Returns

IOrpheusTableOptions

An IOrpheusTableOptions instance

LoadFrom(Stream)

Load definition from stream.

void LoadFrom(Stream stream)

Parameters

stream Stream

LoadFrom(string)

Loads definition from a file.

void LoadFrom(string fileName)

Parameters

fileName string

LoadFromDB(string)

Loads definition from the connected database.

void LoadFromDB(string moduleName)

Parameters

moduleName string

SaveTo(Stream)

Saves definition to a stream.

void SaveTo(Stream stream)

Parameters

stream Stream

SaveTo(string)

Saves definition to a file.

void SaveTo(string fileName)

Parameters

fileName string

SaveToDB()

Saves the definition the connected database.

void SaveToDB()