Class PivotInterpretaor
A helper class for interpreting IPivot entity settings
Inheritance
Inherited Members
Namespace: LemonEdge.API.Entities.Helpers
Assembly: API.dll
Syntax
public class PivotInterpretaorConstructors
PivotInterpretaor(IPivot)
Creates a new pivot interpretor for the specified pivot
Declaration
public PivotInterpretaor(IPivot pivot)Parameters
| Type | Name | Description |
|---|---|---|
| IPivot | pivot | The pivot to use for this interpretor |
PivotInterpretaor(Guid)
Creates a new pivot interpretor for the unique global id of a pivot record
Declaration
public PivotInterpretaor(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | The unique global id of a pivot |
Properties
Fields
An enumeration of all fields in the pivot
Declaration
public IEnumerable<IPivotFieldInfo> Fields { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<IPivotFieldInfo> |
Loaded
Indicates if this interpretor has been loaded or not yet
Declaration
public bool Loaded { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Pivot
The pivot this interpretor is using
Declaration
public IPivot Pivot { get; }Property Value
| Type | Description |
|---|---|
| IPivot |
SQLWrapper
The sql wrapper interpretor that backs this pivot
Declaration
public SQLWrapperInterpretor SQLWrapper { get; }Property Value
| Type | Description |
|---|---|
| SQLWrapperInterpretor |
Methods
Load(IEntityRetriever)
Loads the specified pivot and its associated sql wrapper interpretor
Declaration
public Task Load(IEntityRetriever retriever)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityRetriever | retriever | The context to load this pivot in. Used when the pivot or sql wrapper could be being changed by the user. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A task indicating the completion of this operation |
Load(IReadOnlyCache)
Loads the specified pivot and its associated sql wrapper interpretor
Declaration
public Task Load(IReadOnlyCache cache)Parameters
| Type | Name | Description |
|---|---|---|
| IReadOnlyCache | cache | A local cache. Used when the pivot just needs to be loaded and displayed/executed, not when the user could be modifying it |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A task indicating the completion of this operation |