Interface IBaseDataSetProcessorFactory
An interface for creating a particular ProcessorType inheriting from IBaseDataSetProcessor
Implement this for any given custom created IBaseDataSetProcessor and the system can integrate with it using DataSetProcessorFactory
Namespace: LemonEdge.API.Processors
Assembly: API.dll
Syntax
public interface IBaseDataSetProcessorFactoryProperties
ProcessorType
The type of processor this factory is responsible for creating
Declaration
Type ProcessorType { get; }Property Value
| Type | Description |
|---|---|
| System.Type |
TypesInDataSet
A list of the types of entities that this factory can create processors for
Declaration
EntityDescriptor[] TypesInDataSet { get; }Property Value
| Type | Description |
|---|---|
| EntityDescriptor[] |
Methods
BelongsToDataSetProccessorType(IBaseEntity)
Indicates if the specified item actualy belongs to the processor this factory creates.
Some processors may be created for all instances of a type in TypesInDataSet, and others may only work on certain ones (such as items implementing ICanBeTransfered would be left alone if being transferred by another processor)
Declaration
bool BelongsToDataSetProccessorType(IBaseEntity item)Parameters
| Type | Name | Description |
|---|---|---|
| IBaseEntity | item | The item to see if it belongs in the type of processor this factory creates |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the specified item actualy belongs to the processor this factory creates. |
Create(IEntityUpdater, IReadOnlyCache, UserInfo)
Creates a new instance of the processor from this factory
Declaration
IBaseDataSetProcessor Create(IEntityUpdater updater, IReadOnlyCache cache, UserInfo user)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityUpdater | updater | A context for querying and updating all items in the LemonEdge platform |
| IReadOnlyCache | cache | A local current cache |
| UserInfo | user | The current logged in user |
Returns
| Type | Description |
|---|---|
| IBaseDataSetProcessor | A new instance of the processor from this factory |