Class ConsolidatedResultCacheBase
Cache for collector results
Inheritance
ConsolidatedResultCacheBase
Inherited Members
Namespace: PayrollEngine.Client.Scripting
Assembly: PayrollEngine.Client.Scripting.dll
Syntax
public abstract class ConsolidatedResultCacheBase
Constructors
View SourceConsolidatedResultCacheBase(DateTime, PayrunJobStatus?, ResultCacheCycle)
Cache constructor
Declaration
protected ConsolidatedResultCacheBase(DateTime cycleStartDate, PayrunJobStatus? jobStatus = null, ResultCacheCycle cacheCycle = ResultCacheCycle.PreviousCycle)
Parameters
| Type | Name | Description |
|---|---|---|
| DateTime | cycleStartDate | The cycle start date |
| PayrunJobStatus? | jobStatus | The payrun job status |
| ResultCacheCycle | cacheCycle | The result cache cycle |
Properties
View SourceJobStatus
The payrun job status
Declaration
protected PayrunJobStatus? JobStatus { get; }
Property Value
| Type | Description |
|---|---|
| PayrunJobStatus? |
Methods
View SourceGetCacheStartDate(PayrunFunction)
Get start date of previous cycle
Declaration
protected DateTime GetCacheStartDate(PayrunFunction function)
Parameters
| Type | Name | Description |
|---|---|---|
| PayrunFunction | function | The payrun function |
Returns
| Type | Description |
|---|---|
| DateTime |
GetConsolidatedPeriodStarts(PayrunFunction, ConsolidatedResultQuery)
Get consolidated period starts from the query moment until the current period
Declaration
protected List<DateTime> GetConsolidatedPeriodStarts(PayrunFunction function, ConsolidatedResultQuery query)
Parameters
| Type | Name | Description |
|---|---|---|
| PayrunFunction | function | The payrun function |
| ConsolidatedResultQuery | query | The consolidated result query |
Returns
| Type | Description |
|---|---|
| List<DateTime> | The period start dates |
IsMatchingPeriodStarts(IList<DateTime>, DateTime)
Check for matching result period
Declaration
protected static bool IsMatchingPeriodStarts(IList<DateTime> periodStarts, DateTime resultStart)
Parameters
| Type | Name | Description |
|---|---|---|
| IList<DateTime> | periodStarts | The period starts |
| DateTime | resultStart | The result start date |
Returns
| Type | Description |
|---|---|
| bool | True on matching period |
IsMatchingTags(IList<string>, IList<string>)
Check for matching result tags
Declaration
protected static bool IsMatchingTags(IList<string> queryTags, IList<string> resultTags)
Parameters
| Type | Name | Description |
|---|---|---|
| IList<string> | queryTags | The query tags |
| IList<string> | resultTags | The result tags |
Returns
| Type | Description |
|---|---|
| bool | True on matching tags |