Class CreateCapitalAccountData
A helper class for executing the system default CreateCapitalAccountData procedure
See https://web.lemonedge.com/help/createcapitalaccountdata/ for more information.
Inheritance
Inherited Members
Namespace: LemonEdge.API.Entities.Helpers.Queries
Assembly: API.dll
Syntax
public class CreateCapitalAccountData : SQLWrapperExecuter
  Constructors
CreateCapitalAccountData(IEntityRetriever, IReadOnlyCache)
Creates a new SQLWrapperExecuter for the CreateCapitalAccountData standard SQL Wrapper query
Declaration
public CreateCapitalAccountData(IEntityRetriever retriever, IReadOnlyCache cache)
  Parameters
| Type | Name | Description | 
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform  | 
      
| IReadOnlyCache | cache | A local cache  | 
      
Fields
QUERYNAME
Global name of the SQLWrapper query
Declaration
public const string QUERYNAME = "CreateCapitalAccountData"
  Field Value
| Type | Description | 
|---|---|
| System.String | 
Methods
AddCommitted(Boolean)
Indicates if this process should include committed transactions or not
Declaration
public CreateCapitalAccountData AddCommitted(bool includeCommitted)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Boolean | includeCommitted | Indicates if this process should include committed transactions or not  | 
      
Returns
| Type | Description | 
|---|---|
| CreateCapitalAccountData | This CreateCapitalAccountData instance for chaining commands  | 
      
AddPeriodEndID(Guid)
The period end parameter for the CreateCapitalAccountData sql wrapper
Declaration
public CreateCapitalAccountData AddPeriodEndID(Guid periodEndID)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Guid | periodEndID | The period end id to run the CreateCapitalAccountData query with  | 
      
Returns
| Type | Description | 
|---|---|
| CreateCapitalAccountData | This CreateCapitalAccountData instance for chaining commands  | 
      
Execute(IEntityRetriever, IReadOnlyCache, Guid, Boolean)
Executes the CreateCapitalAccountData system SQLWrapper using the specified parameters
Declaration
public static Task Execute(IEntityRetriever retriever, IReadOnlyCache cache, Guid periodEndID, bool includeCommitted)
  Parameters
| Type | Name | Description | 
|---|---|---|
| IEntityRetriever | retriever | A IEntityRetriever context for querying the LemonEdge platform  | 
      
| IReadOnlyCache | cache | A local cache  | 
      
| System.Guid | periodEndID | The period end parameter for the CreateCapitalAccountData sql wrapper  | 
      
| System.Boolean | includeCommitted | Indicates if this process should include committed transactions or not  | 
      
Returns
| Type | Description | 
|---|---|
| System.Threading.Tasks.Task | A task indicating the completion of running the CreateCapitalAccountData procedure  | 
      
Execute(Guid, Boolean)
Executes the CreateCapitalAccountData system SQLWrapper using the specified parameters
Declaration
public Task Execute(Guid periodEndID, bool includeCommitted)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Guid | periodEndID | The period end parameter for the CreateCapitalAccountData sql wrapper  | 
      
| System.Boolean | includeCommitted | Indicates if this process should include committed transactions or not  | 
      
Returns
| Type | Description | 
|---|---|
| System.Threading.Tasks.Task | A task indicating the completion of running the CreateCapitalAccountData procedure  | 
      
ParametersAreValid()
Indicates if the parameters are valid for executing the query
Declaration
protected override bool ParametersAreValid()
  Returns
| Type | Description | 
|---|---|
| System.Boolean | True if the parameters contain a value for @periodEndID  |