Class OrpheusModuleDefinition

Namespace

OrpheusCore

Assembly

OrpheusCore.dll

The OrpheusModuleDefinition can save and load a module definition. A module definition, includes relationship between the module tables and that is required for a module to be functional. IOrpheusModule

public class OrpheusModuleDefinition : IOrpheusModuleDefinition

Inheritance

object

OrpheusModuleDefinition

Implements

IOrpheusModuleDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OrpheusModuleDefinition()

Initializes a new instance of the OrpheusModuleDefinition class.

public OrpheusModuleDefinition()

Properties

Database

[IgnoreDataMember]
public IOrpheusDatabase Database { get; set; }

Property Value

IOrpheusDatabase

Orpheus database.

DetailTableOptions

public List<IOrpheusTableOptions> DetailTableOptions { get; set; }

Property Value

List<IOrpheusTableOptions>

List of module's detail table options.

MainTableOptions

public IOrpheusTableOptions MainTableOptions { get; set; }

Property Value

IOrpheusTableOptions

Module's main table options.

Name

public string Name { get; set; }

Property Value

string

Module's name.

ReferenceTableOptions

public List<IOrpheusTableOptions> ReferenceTableOptions { get; set; }

Property Value

List<IOrpheusTableOptions>

List of module reference tables.

Methods

CreateTableOptions()

Creates an instance of OrpheusTableOptions.

public IOrpheusTableOptions CreateTableOptions()

Returns

IOrpheusTableOptions

An IOrpheusTableOptions instance

CreateTableOptions(string, Type)

Creates an instance of OrpheusTableOptions.

public IOrpheusTableOptions CreateTableOptions(string tableName, Type modelType)

Parameters

tableName string

The table name.

modelType Type

The model type.

Returns

IOrpheusTableOptions

An IOrpheusTableOptions instance

CreateTableOptions(Type)

Creates an instance of OrpheusTableOptions.

public IOrpheusTableOptions CreateTableOptions(Type modelType)

Parameters

modelType Type

The model type.

Returns

IOrpheusTableOptions

An IOrpheusTableOptions instance

LoadFrom(Stream)

Load definition from stream.

public void LoadFrom(Stream stream)

Parameters

stream Stream

The stream.

LoadFrom(string)

Loads definition from a file.

public void LoadFrom(string fileName)

Parameters

fileName string

The filename.

LoadFromDB(string)

Loads definition from the connected database.

public void LoadFromDB(string moduleName)

Parameters

moduleName string

The module name.

SaveTo(Stream)

Save definition to memory.

public void SaveTo(Stream stream)

Parameters

stream Stream

The stream.

SaveTo(string)

Save definition to a file.

public void SaveTo(string fileName)

Parameters

fileName string

The filename.

SaveToDB()

Save definition to the database.

public void SaveToDB()