Class EntitySetStructure
A class responsible for taking an IEntitySetBase and loading its structure , allowing that to be traversed using nodes and links
This structure comes from the EntitySets entities (ISetEntity), their rules (IAllocationRule) and paths (IAllocationPath)
Inheritance
System.Object
EntitySetStructure
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.API.Entities.Helpers
Assembly: API.dll
Syntax
public class EntitySetStructure
Constructors
EntitySetStructure(IEntitySetBase, IAllocationPath, Boolean)
Creates a new entity structure for the given entity set, and an optional path to highlight
Declaration
public EntitySetStructure(IEntitySetBase set, IAllocationPath highlightPath, bool showChainedAllocations)
Parameters
Type | Name | Description |
---|---|---|
IEntitySetBase | set | The entity set to load and display its structure for |
IAllocationPath | highlightPath | An optional path to highlight within the structure |
System.Boolean | showChainedAllocations |
Properties
Links
All the links between entities within the structure
Declaration
public IEnumerable<EntityStructureLink> Links { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntityStructureLink> |
Nodes
All the entities within the structure
Declaration
public IEnumerable<EntitySetStructureNode> Nodes { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<EntitySetStructureNode> |
Methods
Load(IEntityRetriever)
Loads the entities in the entity set, and calculates the structure between the entities from allocation rules and paths
Declaration
public Task Load(IEntityRetriever retriever)
Parameters
Type | Name | Description |
---|---|---|
IEntityRetriever | retriever | The context to load the structure with |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | A task representing the completion of the operation |