51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData Interface Reference

Detailed Description

51Degrees specific meta data.

This adds meta data properties which are available in 51Degrees Engines.

Inheritance diagram for FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData:

[legend]

Public Member Functions

IComponentMetaData  GetComponent ()
Get the component which the property belongs to. More...
IEnumerable< IValueMetaData >  GetValues ()
Get the values which relate to the property i.e. More...
IValueMetaData  GetValue (string valueName)
Get the value from the property which has the name provided. More...
IValueMetaData  GetDefaultValue ()
Get the default value for this property. More...

Properties

string  Url [get]
URL relating to the property. More...
byte  DisplayOrder [get]
Order to display the property. More...
bool  Mandatory [get]
True if the property is mandatory. More...
bool  List [get]
True if the property value type is a list. More...
bool  Obsolete [get]
True if the property is obsolete. More...
bool  Show [get]
True if the property should be shown. More...
bool  ShowValues [get]
True if the values of the property should be shown. More...
IComponentMetaData  Component [get]
The component which the property belongs to. More...
IReadOnlyList< IValueMetaData >  Values [get]
The list of values which relate to the property i.e. More...
IValueMetaData  DefaultValue [get]
The default value for this property. More...

Member Function Documentation

◆ GetComponent()

IComponentMetaData FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.GetComponent ( )

Get the component which the property belongs to.

Returns
The component

◆ GetDefaultValue()

IValueMetaData FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.GetDefaultValue ( )

Get the default value for this property.

Returns
Default value

◆ GetValue()

IValueMetaData FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.GetValue ( string   valueName )

Get the value from the property which has the name provided.

Null is returned if the property does not contain a value with the name provided

Parameters
valueName - Name of the value to return
Returns
The value or null if not in this property

◆ GetValues()

IEnumerable<IValueMetaData> FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.GetValues ( )

Get the values which relate to the property i.e.

the values which can be returned for this property.

Returns
Values enumerable

Property Documentation

◆ Component

IComponentMetaData FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.Component
get

The component which the property belongs to.

◆ DefaultValue

IValueMetaData FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.DefaultValue
get

The default value for this property.

◆ DisplayOrder

byte FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.DisplayOrder
get

Order to display the property.

◆ List

bool FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.List
get

True if the property value type is a list.

◆ Mandatory

bool FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.Mandatory
get

True if the property is mandatory.

◆ Obsolete

bool FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.Obsolete
get

True if the property is obsolete.

◆ Show

bool FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.Show
get

True if the property should be shown.

◆ ShowValues

bool FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.ShowValues
get

True if the values of the property should be shown.

◆ Url

string FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.Url
get

URL relating to the property.

◆ Values

IReadOnlyList<IValueMetaData> FiftyOne.Pipeline.Engines.FiftyOne.Data.IFiftyOneAspectPropertyMetaData.Values
get

The list of values which relate to the property i.e.

the values which can be returned for this property.