IsHoliday Method

IsHolidy returns a Boolean value specifying whether a day is a defined holiday and returns the schedule hours type for that day. This method returns TRUE if the Working field is cleared for the holiday definition of that day, or FALSE if the Working field is selected. For more information about setting schedule hours, see Setting Hours of Availability. For more information about the Working field, see Setting Exception Hours.

This method is not used as part of any workflow process.

Arguments

The following table describes the arguments for this method.

Argument Name Description

Calendar Id

The ID of the schedule that is associated with the potential holiday.

Date Time

The date and time for the potential holiday. This argument uses one of the following formats:

  • mm/dd/yyyy hh:mm:ss

  • m/dd/yy hh:mm:s

The first part of the format designates a date (month/date/year). For this part, the separator can be a slash (/) or a hyphen (-). The second part of the format designates a time (hour:minute:second).

Time Zone

The time zone for the potential holiday.

Return Values

The following table describes the return values for this method.

Return Value Description

Is Holiday

A value that indicates whether the day is a holiday. Values include:

  • TRUE. Indicates that the day is a holiday.

  • FALSE. Indicates that the day is not a holiday.

Working Hours

The type of schedule hours for the day (for example, normal, overtime, or extended overtime).