Class DbMetadataDefinition

Describes a metadata definition

Inheritance

System.Object

DbMetadataDefinition

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: ImageVault.Core.Common.DbEntities

Assembly: ImageVault.Core.dll

Syntax

public class DbMetadataDefinition

Constructors

DbMetadataDefinition()

Initializes a new instance of the DbMetadataDefinition class.

Declaration

public DbMetadataDefinition()

DbMetadataDefinition(MetadataDefinition)

Initializes a new instance of the DbMetadataDefinition class.

Declaration

public DbMetadataDefinition(MetadataDefinition definition)

Parameters

Type	Name	Description
MetadataDefinition	definition

DbMetadataDefinition(DbMetadataDefinition)

Copy constructor

Declaration

public DbMetadataDefinition(DbMetadataDefinition definition)

Parameters

Type	Name	Description
DbMetadataDefinition	definition

Properties

Description

Get/Sets the Description of the DbMetadataDefinition

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

IsMultilingual

Get/Sets the IsMultilingual of the DbMetadataDefinition

Declaration

public bool IsMultilingual { get; set; }

Property Value

Type	Description
System.Boolean	If true, the value can be translated to other languages

IsReadOnly

Get/Sets the IsReadOnly of the DbMetadataDefinition

Declaration

public bool IsReadOnly { get; set; }

Property Value

Type	Description
System.Boolean	If true, the value of the DbMetadata cannot be changed

MetadataDefinitionId

Get/Sets the MetadataDefinitionId of the DbMetadataDefinition

Declaration

public int MetadataDefinitionId { get; set; }

Property Value

Type	Description
System.Int32

MetadataDefinitionType

Get/Sets the MetadataDefinitionType of the DbMetadataDefinition

Declaration

public MetadataDefinitionTypes MetadataDefinitionType { get; set; }

Property Value

Type	Description
MetadataDefinitionTypes

MetadataDefinitionTypeId

Get/Sets the MetadataDefinitionTypeId of the DbMetadataDefinition

Declaration

public int MetadataDefinitionTypeId { get; set; }

Property Value

Type	Description
System.Int32

MetadataType

Get/Sets the MetadataType of the DbMetadataDefinition

Declaration

public MetadataTypes MetadataType { get; set; }

Property Value

Type	Description
MetadataTypes

MetadataTypeId

Get/Sets the MetadataTypeId of the DbMetadataDefinition

Declaration

public int MetadataTypeId { get; set; }

Property Value

Type	Description
System.Int32

Name

Get/Sets the Name of the DbMetadataDefinition

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

SymbolKey

Get/Sets the SymbolKey of the MetadataDefinition

Declaration

public string SymbolKey { get; set; }

Property Value

Type	Description
System.String	If true, a symbol will be shown on media in e.g. media libraries

Methods

CreateMetadataInstance()

Creates a DbMetadata instance based on the DbMetadataDefinition

Declaration

public DbMetadata CreateMetadataInstance()

Returns

Type	Description
DbMetadata	The created DbMetadata instance

Exceptions

Type	Condition
System.NotImplementedException	If no concrete type is implemented for the MetadataType

ToMetadataDefinition()

Declaration

public MetadataDefinition ToMetadataDefinition()

Returns

Type	Description
MetadataDefinition

ToString()

Returns a System.String that represents the current DbMetadataDefinition.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current DbMetadataDefinition.

Overrides

System.Object.ToString()

ValidateMetadataType(DbMetadata)

Validates the supplied DbMetadata and makes sure that it is compatible with the definition

Declaration

public void ValidateMetadataType(DbMetadata dbMetadata)

Parameters

Type	Name	Description
DbMetadata	dbMetadata	The DbMetadata to validate

Exceptions

Type	Condition
System.ArgumentNullException	If dbMetadata is null.
MalformedMetadataException	If the DbMetadata is not compatible with the definition
System.NotImplementedException	If a concrete implementation of the MetadataType is missing.