Package ch.ivyteam.ivy.application.calendar

Interface IDefaultBusinessCalendar

All Superinterfaces:

IBusinessCalendar

public interface IDefaultBusinessCalendar
extends IBusinessCalendar

The default business calendar represents the default IBusinessCalendar used in the current context.

To explicitly get a different IBusinessCalendar use get(String).

It is possible to define a specific IDefaultBusinessCalendar for each Environment, Case and Task.

Priority:

1. Task: The IBusinessCalendar set on a task is always used as default in the context of the task. It cannot be overwritten.
2. Case: The IBusinessCalendar set on a case is used as default in the context of the case, as long as it is not overwritten on the current task.
3. Environment: The IBusinessCalendar set on an environment is used as default when the environment is active, as long as it is not overwritten on the current case or task.
4. Global: The global default IBusinessCalendar is only used if it is not overwritten on the current environment, case or task.

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
static IDefaultBusinessCalendar	current()	Gets the current default business calendar.
IBusinessCalendar	get(String calendarName)	Gets an instance of a specific calendar.

Methods inherited from interface ch.ivyteam.ivy.application.calendar.IBusinessCalendar

getBusinessDuration, getBusinessTimeIn, getBusinessTimeIn, getFirstWorkDayOfMonth, getFirstWorkDayOfWeek, getFirstWorkDayOfYear, getLastWorkDayOfMonth, getLastWorkDayOfWeek, getLastWorkDayOfYear, getName, getWorkDayIn, getWorkDayIn, getWorkDayIn, getWorkDayIn, getWorkDayIn, isWorkDay, isWorkTime

Method Details

get

IBusinessCalendar get(String calendarName)

Gets an instance of a specific calendar. If no calendar with calendarName was found the default calendar is returned.

Parameters:

calendarName - Name of a specific calendar

Returns:

Instance of the specified calendar. Never null.

API:

This public API is available in IvyScript and Java. It has the visibility NOVICE.

current

static IDefaultBusinessCalendar current()

Gets the current default business calendar.

Will return null if called out of scope. The scope is set if you call this method from an ivy process or any supported ivy environment. It is not set in non supported ivy environments (e.g. if you start your own threads, etc.).

Returns:

current default business calendar or null if out of scope

Since:

9.1

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.