Class GetPathInfo
A helper class for executing the system default GetPathInfo query
See https://help.lemonedge.com/getpathinfo/ for more information.
Inheritance
Inherited Members
Namespace: LemonEdge.API.Core.FinancialServices.Helpers
Assembly: LemonEdge.API.Core.FinancialServices.dll
Syntax
public class GetPathInfo : SQLWrapperExecuter<IPathInfo>Constructors
GetPathInfo(IEntityRetriever, IReadOnlyCache)
Creates a new SQLWrapperExecuter for the GetPathInfo standard SQL Wrapper query
Declaration
public GetPathInfo(IEntityRetriever retriever, IReadOnlyCache cache)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform |
| IReadOnlyCache | cache | A local cache |
Fields
PARAM_EFFECTIVEDATE
The ParameterName for the EffectiveDate parameter
Declaration
public const string PARAM_EFFECTIVEDATE = "@effectiveDate"Field Value
| Type | Description |
|---|---|
| string |
PARAM_ENTITYSET
The ParameterName for the EntitySetID parameter
Declaration
public const string PARAM_ENTITYSET = "@entitySetID"Field Value
| Type | Description |
|---|---|
| string |
PARAM_FLATTEN
The ParameterName for the Flatten parameter
Declaration
public const string PARAM_FLATTEN = "@flatten"Field Value
| Type | Description |
|---|---|
| string |
PARAM_PATH
The ParameterName for the PathID parameter
Declaration
public const string PARAM_PATH = "@pathID"Field Value
| Type | Description |
|---|---|
| string |
PARAM_STEPCHANGEDATE
The ParameterName for the Step Change parameter
Declaration
public const string PARAM_STEPCHANGEDATE = "@stepDate"Field Value
| Type | Description |
|---|---|
| string |
QUERYNAME
Global name of the SQLWrapper query
Declaration
public const string QUERYNAME = "GetPathInfo"Field Value
| Type | Description |
|---|---|
| string |
Methods
AddEffectiveDate(DateTimeOffset)
Indicates only to use allocations that have an effective date less than or equal to this. This would exclude new allocations, or transfers depending on the date
Declaration
public GetPathInfo AddEffectiveDate(DateTimeOffset effectiveDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTimeOffset | effectiveDate | The effective date to run the GetPathInfo query with |
Returns
| Type | Description |
|---|---|
| GetPathInfo | This GetPathInfo instance for chaining commands |
AddEntitySetID(Guid?)
The entity set you want to return path information for. Paths are designed to work within the structure of a given entity set
Declaration
public GetPathInfo AddEntitySetID(Guid? entitySetID)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | entitySetID |
Returns
| Type | Description |
|---|---|
| GetPathInfo | This GetPathInfo instance for chaining commands |
AddFlatten(bool)
Indicates if duplicate allocations to the same entity, or transfers, should be aggregated together. This way you only have one percentage per ultimate owner, without it you will have multiple ones that have to be aggregated together to get the final amount.
Declaration
public GetPathInfo AddFlatten(bool flatten)Parameters
| Type | Name | Description |
|---|---|---|
| bool | flatten | The flatten value to run the GetPathInfo query with |
Returns
| Type | Description |
|---|---|
| GetPathInfo | This GetPathInfo instance for chaining commands |
AddPathID(Guid?)
The ID of a specific path you want the allocations for. If this is null the results will include all paths within the given entity set
Declaration
public GetPathInfo AddPathID(Guid? pathID)Parameters
| Type | Name | Description |
|---|---|---|
| Guid? | pathID | The path ID to run the GetPathInfo query with |
Returns
| Type | Description |
|---|---|
| GetPathInfo | This GetPathInfo instance for chaining commands |
AddStepChangeDate(DateTimeOffset?)
Indicates only to use allocations that have a blank step change date or one less than or equal to this. This would exclude future closings
Declaration
public GetPathInfo AddStepChangeDate(DateTimeOffset? stepDate)Parameters
| Type | Name | Description |
|---|---|---|
| DateTimeOffset? | stepDate | The step date to run the GetPathInfo query with |
Returns
| Type | Description |
|---|---|
| GetPathInfo | This GetPathInfo instance for chaining commands |
Execute(IEntityRetriever, IReadOnlyCache, DateTimeOffset, Guid, bool, DateTimeOffset?, Guid[], QueryableExecuter<IPathInfo>)
Executes the GetPathInfo system SQLWrapper using the specified parameters, and returns the results of the results of that query
Declaration
public static Task<IEnumerable<IPathInfo>> Execute(IEntityRetriever retriever, IReadOnlyCache cache, DateTimeOffset effectiveDate, Guid entitySetID, bool flatten, DateTimeOffset? stepDate, Guid[] pathIDs, QueryableExecuter<IPathInfo> filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform |
| IReadOnlyCache | cache | A local cache |
| DateTimeOffset | effectiveDate | Indicates only to use allocations that have an effective date less than or equal to this. This would exclude new allocations, or transfers depending on the date |
| Guid | entitySetID | The entity set you want to return path information for. Paths are designed to work within the structure of a given entity set |
| bool | flatten | Indicates if duplicate allocations to the same entity, or transfers, should be aggregated together. This way you only have one percentage per ultimate owner, without it you will have multiple ones that have to be aggregated together to get the final amount. |
| DateTimeOffset? | stepDate | |
| Guid[] | pathIDs | A list of IDs of a specific path you want the allocations for. If this is null the results will include all paths within the given entity set |
| QueryableExecuter<IPathInfo> | filter | An optional QueryableExecuter<T> that holds any filtering to apply to the query |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<IPathInfo>> | A task holding the results of executing the GetPathInfo query with the specified parameters |
Execute(IEntityRetriever, IReadOnlyCache, DateTimeOffset, Guid, bool, Guid?, DateTimeOffset?, QueryableExecuter<IPathInfo>)
Executes the GetPathInfo system SQLWrapper using the specified parameters, and returns the results of the results of that query
Declaration
public static Task<IEnumerable<IPathInfo>> Execute(IEntityRetriever retriever, IReadOnlyCache cache, DateTimeOffset effectiveDate, Guid entitySetID, bool flatten, Guid? pathID, DateTimeOffset? stepDate, QueryableExecuter<IPathInfo> filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform |
| IReadOnlyCache | cache | A local cache |
| DateTimeOffset | effectiveDate | Indicates only to use allocations that have an effective date less than or equal to this. This would exclude new allocations, or transfers depending on the date |
| Guid | entitySetID | The entity set you want to return path information for. Paths are designed to work within the structure of a given entity set |
| bool | flatten | Indicates if duplicate allocations to the same entity, or transfers, should be aggregated together. This way you only have one percentage per ultimate owner, without it you will have multiple ones that have to be aggregated together to get the final amount. |
| Guid? | pathID | The ID of a specific path you want the allocations for. If this is null the results will include all paths within the given entity set |
| DateTimeOffset? | stepDate | |
| QueryableExecuter<IPathInfo> | filter | An optional QueryableExecuter<T> that holds any filtering to apply to the query |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<IPathInfo>> | A task holding the results of executing the GetPathInfo query with the specified parameters |
Execute(DateTimeOffset, Guid, bool, DateTimeOffset?, Guid[], QueryableExecuter<IPathInfo>)
Executes the GetPathInfo system SQLWrapper using the specified parameters, and returns the results of the results of that query
Declaration
public Task<IEnumerable<IPathInfo>> Execute(DateTimeOffset effectiveDate, Guid entitySetID, bool flatten, DateTimeOffset? stepDate, Guid[] pathIDs, QueryableExecuter<IPathInfo> filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| DateTimeOffset | effectiveDate | Indicates only to use allocations that have an effective date less than or equal to this. This would exclude new allocations, or transfers depending on the date |
| Guid | entitySetID | The entity set you want to return path information for. Paths are designed to work within the structure of a given entity set |
| bool | flatten | Indicates if duplicate allocations to the same entity, or transfers, should be aggregated together. This way you only have one percentage per ultimate owner, without it you will have multiple ones that have to be aggregated together to get the final amount. |
| DateTimeOffset? | stepDate | |
| Guid[] | pathIDs | A list of IDs of a specific path you want the allocations for. If this is null the results will include all paths within the given entity set |
| QueryableExecuter<IPathInfo> | filter | An optional QueryableExecuter<T> that holds any filtering to apply to the query |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<IPathInfo>> | A task holding the results of executing the GetPathInfo query with the specified parameters |
Execute(DateTimeOffset, Guid, bool, Guid?, DateTimeOffset?, QueryableExecuter<IPathInfo>)
Executes the GetPathInfo system SQLWrapper using the specified parameters, and returns the results of the results of that query
Declaration
public Task<IEnumerable<IPathInfo>> Execute(DateTimeOffset effectiveDate, Guid entitySetID, bool flatten, Guid? pathID, DateTimeOffset? stepDate, QueryableExecuter<IPathInfo> filter = null)Parameters
| Type | Name | Description |
|---|---|---|
| DateTimeOffset | effectiveDate | Indicates only to use allocations that have an effective date less than or equal to this. This would exclude new allocations, or transfers depending on the date |
| Guid | entitySetID | The entity set you want to return path information for. Paths are designed to work within the structure of a given entity set |
| bool | flatten | Indicates if duplicate allocations to the same entity, or transfers, should be aggregated together. This way you only have one percentage per ultimate owner, without it you will have multiple ones that have to be aggregated together to get the final amount. |
| Guid? | pathID | The ID of a specific path you want the allocations for. If this is null the results will include all paths within the given entity set |
| DateTimeOffset? | stepDate | |
| QueryableExecuter<IPathInfo> | filter | An optional QueryableExecuter<T> that holds any filtering to apply to the query |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<IPathInfo>> | A task holding the results of executing the GetPathInfo query with the specified parameters |
ParametersAreValid()
Indicates if the parameters are valid for executing the query
Declaration
protected override bool ParametersAreValid()Returns
| Type | Description |
|---|---|
| bool | True if the parameters contain a value for @effectiveDate, @entitySetID, and @flatten |