Class Calendar
The payroll calendar client object
Assembly: PayrollEngine.Client.Core.dll
Syntax
public class Calendar : ModelBase, ICalendar, IModel, IAttributeObject, IKeyEquatable<ICalendar>, IEquatable<ICalendar>, INameObject
Constructors
Calendar()
Initializes a new instance
Declaration
Calendar(Calendar)
Initializes a new instance from a copy
Declaration
public Calendar(Calendar copySource)
Parameters
| Type |
Name |
Description |
| Calendar |
copySource |
The copy source
|
Properties
Attributes
Declaration
[JsonPropertyOrder(117)]
public Dictionary<string, object> Attributes { get; set; }
Property Value
CycleTimeUnit
The cycle time unit (default: year)
Declaration
[Required]
[JsonPropertyOrder(102)]
public CalendarTimeUnit CycleTimeUnit { get; set; }
Property Value
FirstDayOfWeek
Override the calendar first day of week
Declaration
[JsonPropertyOrder(108)]
public DayOfWeek? FirstDayOfWeek { get; set; }
Property Value
FirstMonthOfYear
The first month of a year (default: january)
Declaration
[JsonPropertyOrder(105)]
public Month? FirstMonthOfYear { get; set; }
Property Value
Name
Declaration
[Required]
[StringLength(128)]
[JsonPropertyOrder(100)]
public string Name { get; set; }
Property Value
NameLocalizations
The localized calendar names
Declaration
[JsonPropertyOrder(101)]
public Dictionary<string, string> NameLocalizations { get; set; }
Property Value
PeriodDayCount
Override the effective period day count
Declaration
[JsonPropertyOrder(106)]
public decimal? PeriodDayCount { get; set; }
Property Value
PeriodTimeUnit
The period time unit (default: calendar month)
Declaration
[Required]
[JsonPropertyOrder(103)]
public CalendarTimeUnit PeriodTimeUnit { get; set; }
Property Value
TimeMap
The time map (default: period)
Declaration
[JsonPropertyOrder(104)]
public CalendarTimeMap TimeMap { get; set; }
Property Value
WeekMode
The week mode (default: week)
Declaration
[JsonPropertyOrder(109)]
public CalendarWeekMode WeekMode { get; set; }
Property Value
WorkFriday
Work on friday (default: true), used by WorkWeek
Declaration
[JsonPropertyOrder(114)]
public bool WorkFriday { get; set; }
Property Value
WorkMonday
Work on monday (default: true), used by WorkWeek
Declaration
[JsonPropertyOrder(110)]
public bool WorkMonday { get; set; }
Property Value
WorkSaturday
Work on saturday (default: false), used by WorkWeek
Declaration
[JsonPropertyOrder(115)]
public bool WorkSaturday { get; set; }
Property Value
WorkSunday
Work on sunday (default: false), used by WorkWeek
Declaration
[JsonPropertyOrder(116)]
public bool WorkSunday { get; set; }
Property Value
WorkThursday
Work on thursday (default: true), used by WorkWeek
Declaration
[JsonPropertyOrder(113)]
public bool WorkThursday { get; set; }
Property Value
WorkTuesday
Work on tuesday (default: true), used by WorkWeek
Declaration
[JsonPropertyOrder(111)]
public bool WorkTuesday { get; set; }
Property Value
WorkWednesday
Work on wednesday (default: true), used by WorkWeek
Declaration
[JsonPropertyOrder(112)]
public bool WorkWednesday { get; set; }
Property Value
YearWeekRule
Override the calendar year start week rule
Declaration
[JsonPropertyOrder(107)]
public CalendarWeekRule? YearWeekRule { get; set; }
Property Value
Methods
EqualKey(ICalendar)
Test for the same item key
Declaration
public virtual bool EqualKey(ICalendar compare)
Parameters
Returns
Equals(ICalendar)
Declaration
public virtual bool Equals(ICalendar compare)
Parameters
Returns
GetUiString()
Declaration
public override string GetUiString()
Returns
Overrides
Implements
Extension Methods