Class BusinessCalendarService

Service for working with a business calendar.

Implements

IBusinessCalendarService

Index

Constructors

Methods

addWorkingDaysToDate addWorkingQuantsToDate calendarAddWorkingDaysToDateExact getAllCalendarInfos getCalendarInfo getDateDiff getDefaultCalendarInfo getDefaultTimeZoneInfo getFirstQuantStart getLastQuantEnd getRoleCalendarInfo getRoleTimeZoneInfo isWorkingTime rebuildCalendar validateCalendar

Constructors

constructor

new BusinessCalendarService(_cardService: ICardService): BusinessCalendarService
Parameters
- _cardService: ICardService
Returns BusinessCalendarService
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:29

Methods

addWorkingDaysToDate

addWorkingDaysToDate(
    dateTime: string,
    daysOffset: number,
    calendarCardId: string,
    timeZoneUtcOffsetMinutes?: number,
): Promise<string>
Offsets from the specified date/time by the specified number of estimated business days..
Parameters
- dateTime: string
  Date and time.
- daysOffset: number
  Offset in working days. Can be a non-integer number.
- calendarCardId: string
  Calendar card ID.
- OptionaltimeZoneUtcOffsetMinutes: number
  Time zone offset in minutes.
Returns Promise<string>
New date and time.
Implementation of IBusinessCalendarService.addWorkingDaysToDate
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:138

addWorkingQuantsToDate

addWorkingQuantsToDate(
    dateTime: string,
    calendarCardId: string,
    quants: number,
    timeZoneUtcOffsetMinutes?: number,
): Promise<string>
Adds the specified working time in quants to the specified date/time.
Parameters
- dateTime: string
  Date and time.
- calendarCardId: string
  Calendar card ID.
- quants: number
  Working time in quants.
- OptionaltimeZoneUtcOffsetMinutes: number
  Time zone offset in minutes.
Returns Promise<string>
New date and time.
Implementation of IBusinessCalendarService.addWorkingQuantsToDate
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:75

calendarAddWorkingDaysToDateExact

calendarAddWorkingDaysToDateExact(
    dateTime: string,
    interval: number,
    calendarCardId: string,
    timeZoneUtcOffsetMinutes?: number,
): Promise<string>
Adds the specified number of actual business days to the specified date/time.
Parameters
- dateTime: string
  Date and time.
- interval: number
  Number of working days.
- calendarCardId: string
  Calendar card ID.
- OptionaltimeZoneUtcOffsetMinutes: number
  Time zone offset in minutes.
Returns Promise<string>
New date and time.
Implementation of IBusinessCalendarService.calendarAddWorkingDaysToDateExact
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:159

getAllCalendarInfos

getAllCalendarInfos(): Promise<CalendarInfo[]>
Retrieves information about calendars.

Returns Promise<CalendarInfo[]>
Implementation of IBusinessCalendarService.getAllCalendarInfos
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:275

getCalendarInfo

getCalendarInfo(calendarIntId: number): Promise<null | CalendarInfo>
Retrieves information about a calendar by its numeric identifier.
Parameters
- calendarIntId: number
  Calendar numeric identifier.
Returns Promise<null | CalendarInfo>
Implementation of IBusinessCalendarService.getCalendarInfo
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:254

getDateDiff

getDateDiff(
    dateTimeStart: string,
    dateTimeEnd: string,
    calendarCardId: string,
    timeZoneUtcOffsetMinutes?: number,
): Promise<number>
Calculates working hours between two specified dates.
Parameters
- dateTimeStart: string
  Start date.
- dateTimeEnd: string
  End date (must be greater than start date).
- calendarCardId: string
  Calendar card ID.
- OptionaltimeZoneUtcOffsetMinutes: number
  Time zone offset in minutes.
Returns Promise<number>
Working time in quants between two specified dates.
Implementation of IBusinessCalendarService.getDateDiff
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:55

getDefaultCalendarInfo

getDefaultCalendarInfo(): Promise<null | CalendarInfo>
Retrieves information about the default calendar.

Returns Promise<null | CalendarInfo>
Implementation of IBusinessCalendarService.getDefaultCalendarInfo
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:235

getDefaultTimeZoneInfo

getDefaultTimeZoneInfo(): Promise<null | TimeZoneInfo>
Retrieves information about the default time zone.

Returns Promise<null | TimeZoneInfo>
Implementation of IBusinessCalendarService.getDefaultTimeZoneInfo
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:216

getFirstQuantStart

getFirstQuantStart(
    dateTime: string,
    daysOffset: number,
    calendarCardId: string,
    timeZoneUtcOffsetMinutes?: number,
): Promise<string>
Gets the start of the first work quant of the workday, obtained as an offset from the given date.
Parameters
- dateTime: string
  Date in abstract calendar time.
- daysOffset: number
  Offset in working days.
- calendarCardId: string
  Calendar card ID.
- OptionaltimeZoneUtcOffsetMinutes: number
  Time zone offset in minutes.
Returns Promise<string>
The date/time in abstract calendar time of the beginning of the first working quant of the working day.
Implementation of IBusinessCalendarService.getFirstQuantStart
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:96

getLastQuantEnd

getLastQuantEnd(
    dateTime: string,
    daysOffset: number,
    calendarCardId: string,
    timeZoneUtcOffsetMinutes?: number,
): Promise<string>
Gets the end of the last working quant of the working day, obtained by offset from the given date.
Parameters
- dateTime: string
  Date in abstract calendar time.
- daysOffset: number
  Offset in working days.
- calendarCardId: string
  Calendar card ID.
- OptionaltimeZoneUtcOffsetMinutes: number
  Time zone offset in minutes.
Returns Promise<string>
Date\time in abstract calendar time of the end of the last working quant of the working day.
Implementation of IBusinessCalendarService.getLastQuantEnd
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:117

getRoleCalendarInfo

getRoleCalendarInfo(roleId: string): Promise<null | CalendarInfo>
Gets calendar information for the specified role.
Parameters
- roleId: string
  Role ID.
Returns Promise<null | CalendarInfo>
Implementation of IBusinessCalendarService.getRoleCalendarInfo
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:195

getRoleTimeZoneInfo

getRoleTimeZoneInfo(roleId: string): Promise<TimeZoneInfo>
Retrieves information about the time zone of the specified role.
Parameters
- roleId: string
  Role ID.
Returns Promise<TimeZoneInfo>
Implementation of IBusinessCalendarService.getRoleTimeZoneInfo
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:180

isWorkingTime

isWorkingTime(
    dateTime: string,
    calendarCardId: string,
    timeZoneUtcOffsetMinutes?: number,
): Promise<boolean>
Checks whether the specified date/time in the abstract calendar time is working date/time.
Parameters
- dateTime: string
  Date and time to check.
- calendarCardId: string
  Calendar card ID.
- OptionaltimeZoneUtcOffsetMinutes: number
  Time zone offset in minutes.
Returns Promise<boolean>
true if the specified date\time is working; otherwise - false.
Implementation of IBusinessCalendarService.isWorkingTime
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:35

rebuildCalendar

rebuildCalendar(
    operationId: string,
    calendarCardId: string,
    rebuildIndexes?: boolean,
): Promise<void>
Rebuilds the calendar based on the specified settings, incl. list of exceptions.
Parameters
- operationId: string
  Operation ID.
- calendarCardId: string
  Calendar card ID.
- rebuildIndexes: boolean = false
  A sign that indexes in calendars need to be rebuilt.
Returns Promise<void>
Implementation of IBusinessCalendarService.rebuildCalendar
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:305

validateCalendar

validateCalendar(calendarCardId: string): Promise<ValidationResult>
Checks the calendar for absence of gaps between quants.
Parameters
- calendarCardId: string
  Calendar card ID.
Returns Promise<ValidationResult>
Validation result.
Implementation of IBusinessCalendarService.validateCalendar
- Defined in @tessa/platform/src/businessCalendar/businessCalendarService.ts:318

Class BusinessCalendarService

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BusinessCalendarService

Methods

addWorkingDaysToDate

Parameters

Returns Promise<string>

addWorkingQuantsToDate

Parameters

Returns Promise<string>

calendarAddWorkingDaysToDateExact

Parameters

Returns Promise<string>

getAllCalendarInfos

Returns Promise<CalendarInfo[]>

getCalendarInfo

Parameters

Returns Promise<null | CalendarInfo>

getDateDiff

Parameters

Returns Promise<number>

getDefaultCalendarInfo

Returns Promise<null | CalendarInfo>

getDefaultTimeZoneInfo

Returns Promise<null | TimeZoneInfo>

getFirstQuantStart

Parameters

Returns Promise<string>

getLastQuantEnd

Parameters

Returns Promise<string>

getRoleCalendarInfo

Parameters

Returns Promise<null | CalendarInfo>

getRoleTimeZoneInfo

Parameters

Returns Promise<TimeZoneInfo>

isWorkingTime

Parameters

Returns Promise<boolean>

rebuildCalendar

Parameters

Returns Promise<void>

validateCalendar

Parameters

Returns Promise<ValidationResult>

Settings

On This Page