Interface IManager
Provides methods and properties of the manager.
Namespace: Terrasoft.Core
Assembly: Terrasoft.Core.dll
Syntax
public interface IManager
Properties
ItemCount
Number of items.
Declaration
int ItemCount { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Name
Name.
Declaration
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Provider
The provider.
Declaration
ManagerProvider Provider { get; set; }
Property Value
Type | Description |
---|---|
ManagerProvider |
Methods
Clear()
Removes all items from the collection of the manager.
Declaration
void Clear()
FindInstanceByName(String)
Searches for the instance of the manager item with the specified name.
Declaration
object FindInstanceByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the manager item instance to get. |
Returns
Type | Description |
---|---|
System.Object | The instance of the manager item with the |
FindInstanceByUId(Guid)
Searches for the instance of the manager item with the specified unique identifier.
Declaration
object FindInstanceByUId(Guid uid)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Unique identifier of the manager item instance to get. |
Returns
Type | Description |
---|---|
System.Object | The instance of the manager item with the specified |
FindItemByName(String)
Searches for the manager item with the specified name.
Declaration
IManagerItem FindItemByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The manager item name. |
Returns
Type | Description |
---|---|
IManagerItem | The manager item of the IManagerItem type with the |
FindItemByRealUId(Guid)
Returns the manager item by its schema extension unique identifier or null
if item not found.
Declaration
IManagerItem FindItemByRealUId(Guid itemUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | itemUId | Schema extension unique identifier. |
Returns
Type | Description |
---|---|
IManagerItem | Schema manager item or |
FindItemByUId(Guid)
Searches for the manager item with the specified unique identifier.
Declaration
IManagerItem FindItemByUId(Guid uid)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Unique identifier of the manager item to get. |
Returns
Type | Description |
---|---|
IManagerItem | The manager item of the IManagerItem type with the unique |
GetInstanceByName(String)
Gets the instance of the manager item with the specified name.
Declaration
object GetInstanceByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the instance of the manager item with the |
Returns
Type | Description |
---|---|
System.Object | The instance of the manager item with the |
GetInstanceByUId(Guid)
Gets the instance of the manager item with the specified unique identifier.
Declaration
object GetInstanceByUId(Guid uid)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Unique identifier of the manager item instance. |
Returns
Type | Description |
---|---|
System.Object | The instance of the manager item with the specified |
GetItemByName(String)
Gets the manager item with the specified name.
Declaration
IManagerItem GetItemByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The manager item name. |
Returns
Type | Description |
---|---|
IManagerItem | The manager item of the IManagerItem type with the |
GetItemByRealUId(Guid)
Returns the manager item for the specified unique schema extension identifier.
Declaration
IManagerItem GetItemByRealUId(Guid itemUId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | itemUId | Unique identifier of the schema extension. |
Returns
Type | Description |
---|---|
IManagerItem | Manager item for the schema extension with the unique identifier. |
GetItemByUId(Guid)
Gets the manager item with the specified identifier.
Declaration
IManagerItem GetItemByUId(Guid uid)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | uid | Unique identifier of the manager item. |
Returns
Type | Description |
---|---|
IManagerItem | The manager item of the IManagerItem type with the unique |
GetItems()
Gets an enumeration for items of the manager.
Declaration
IEnumerable<IManagerItem> GetItems()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IManagerItem> | The enumeration for items of the manager. |
GetItems(Predicate<IManagerItem>)
Gets an enumeration for the manager items that match the specified criteria.
Declaration
IEnumerable<IManagerItem> GetItems(Predicate<IManagerItem> match)
Parameters
Type | Name | Description |
---|---|---|
System.Predicate<IManagerItem> | match | Criteria that should be matched by the return enumeration members. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<IManagerItem> | The enumeration for items of the manager that match the |
Initialize(ManagerProvider, ManagerProviderConfigurationElement)
Initializes the manager, using the specified manager provider and the information from the configuration file.
Declaration
void Initialize(ManagerProvider provider, ManagerProviderConfigurationElement configuration)
Parameters
Type | Name | Description |
---|---|---|
ManagerProvider | provider | The manager provider. |
ManagerProviderConfigurationElement | configuration | Configuration file information. |