VideoOS.Platform.ConfigurationItems.IConfigurationItem Class Reference

Contains a wrapped instance of a ConfigurationItem. More...

Inheritance diagram for VideoOS.Platform.ConfigurationItems.IConfigurationItem:

Public Member Functions
void	ClearChildrenCache ()
	Clear the internal cache of children. Can be used to force a new set of children to be fetched from the server at next access.
ServerTask	ExecuteMethod (string methodId)
	Execute the provided method. The method id must be one of the defined values in the Methods property.
void	FillChildren (string[] itemTypes)
	Fill all children and grand-children - as long as the itemtype is contained in itemType parameter.
void	FillChildren (string[] itemTypes, ItemFilter[] itemFilters)
	Fill all children and grand-children - as long as the itemtype is contained in itemType parameter and filters match. If multiple filters are defined for same itemtype, all must match for the item to be included ('and' operation). If no filter is defined for an ItemType, then all items of that type is filled.
void	Save ()
	Will save all updated values to server.
ValidateResult	ValidateItem ()
	Validate the current content.
Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem
string	GetProperty (string key)
	Return a property value as string, if key is not found the return value will be null.
ICollection< string >	GetPropertyKeys ()
	Get a collection of all available property keys.
List< ValueTypeInfo >	GetValueTypeInfoList (string propertyKey)
	Get defined ValueTypeInfo for a given property. If no ValueTypeInfo is available, an empty list is returned.
void	SetProperty (string key, string content)
	Sets the value of a property (all is string format here)
override string	ToString ()
	Display the 'DisplayName' is the default ToString()

Properties
Guid	Guid [get]
	Returns the id property or part of the path, when available. When no id is available this will be Guid.Empty. This is relevant for some items of ItemCategory.ChildItem where no property with key = "Id" exists and path does not contains a guid.
Collection< string >	Methods [get]
	The available methods for this class.
Properties inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem
string	Description [get, set]
	Description.
virtual string	DisplayName [get]
	Name of this ConfigurationItem in user readable format. Usually the same as property with key = "Name".
string	ItemCategory [get]
	Return the item category for this item. This can be used to understand how multiple items are fetched and saved together. Only ItemCategory == 'Item' can be saved.
string	Name [get, set]
	Name.
string	ParentItemPath [get]
	Get hold of the next real parent path, e.g. skip any 'Folder' type parent.
string	ParentPath [get]
	The path for the parent of this ConfigurationItem.
string	Path [get]
	The identification of this item.
ServerId	ServerId [get, set]
	Contains the ServerId of the Management Server holding this item.

Detailed Description

Contains a wrapped instance of a ConfigurationItem.

Member Function Documentation

ClearChildrenCache()

void VideoOS.Platform.ConfigurationItems.IConfigurationItem.ClearChildrenCache ( )

inline

Clear the internal cache of children. Can be used to force a new set of children to be fetched from the server at next access.

ExecuteMethod()

ServerTask VideoOS.Platform.ConfigurationItems.IConfigurationItem.ExecuteMethod ( string methodId )

inline

Execute the provided method. The method id must be one of the defined values in the Methods property.

Parameters

methodId

Returns

FillChildren() [1/2]

void VideoOS.Platform.ConfigurationItems.IConfigurationItem.FillChildren ( string[] itemTypes )

inline

Fill all children and grand-children - as long as the itemtype is contained in itemType parameter.

Parameters

itemTypes

FillChildren() [2/2]

void VideoOS.Platform.ConfigurationItems.IConfigurationItem.FillChildren ( string[] itemTypes, ItemFilter[] itemFilters )

inline

Fill all children and grand-children - as long as the itemtype is contained in itemType parameter and filters match. If multiple filters are defined for same itemtype, all must match for the item to be included ('and' operation).
If no filter is defined for an ItemType, then all items of that type is filled.

Parameters

itemTypes
itemFilters

Save()

void VideoOS.Platform.ConfigurationItems.IConfigurationItem.Save ( )

inline

Will save all updated values to server.

Can throw exception is values are invalid.

ValidateItem()

ValidateResult VideoOS.Platform.ConfigurationItems.IConfigurationItem.ValidateItem ( )

inline

Validate the current content.

Returns

Property Documentation

Guid

Guid VideoOS.Platform.ConfigurationItems.IConfigurationItem.Guid

get

Returns the id property or part of the path, when available. When no id is available this will be Guid.Empty. This is relevant for some items of ItemCategory.ChildItem where no property with key = "Id" exists and path does not contains a guid.

Methods

Collection<string> VideoOS.Platform.ConfigurationItems.IConfigurationItem.Methods

get

The available methods for this class.