Class BusinessCalendarService

Service for working with a business calendar.

Implements

Constructors

constructor

Methods

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

Constructors

constructor

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.

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.

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.

getAllCalendarInfos

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>

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.

getDefaultCalendarInfo

getDefaultTimeZoneInfo

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.

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.

getRoleCalendarInfo

getRoleTimeZoneInfo

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.

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>

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.

Settings

Member Visibility

On This Page

Constructors
Methods
MMNEPVFCICPMFPCPTTAAATR