Package ch.ivyteam.ivy.application.calendar

Interface IBusinessCalendarSettings

public interface IBusinessCalendarSettings

Reads, writes, creates and deletes IBusinessCalendarConfigurations

Each IApplication has its own IBusinessCalendarSettings (see IApplication.getBusinessCalendarSettings()).

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
IBusinessCalendarConfiguration	createBusinessCalendarConfiguration(String name)	Creates a new IBusinessCalendarConfiguration identified by the name.
void	deleteBusinessCalendarConfiguration(IBusinessCalendarConfiguration businessCalendarConfiguration)	Deletes the IBusinessCalendarConfiguration businessCalendarConfiguration.
IBusinessCalendarConfiguration	findBusinessCalendarConfiguration(Long id)	Deprecated, for removal: This API element is subject to removal in a future version. use findBusinessCalendarConfiguration(String) instead
IBusinessCalendarConfiguration	findBusinessCalendarConfiguration(String name)	Finds the IBusinessCalendarConfiguration identified by the name.
Tree	getAllBusinessCalendarConfigurations()	Returns an Tree containing all IBusinessCalendarConfigurations
List<IBusinessCalendarConfiguration>	getAllBusinessCalendarConfigurationsAsList()	Returns an List containing all IBusinessCalendarConfigurations
Long	getBusinessCalendarId(IBusinessCalendar calendar)	Deprecated, for removal: This API element is subject to removal in a future version. use IBusinessCalendar.getName() instead to identify a calendar
Long	getBusinessCalendarId(String calendarName)	Deprecated, for removal: This API element is subject to removal in a future version. use calendar name to identify calendars
IBusinessCalendarConfiguration	getRootBusinessCalendarConfiguration()	Returns the default IBusinessCalendarConfiguration for this application.
void	saveBusinessCalendarConfiguration(IBusinessCalendarConfiguration businessCalendarConfiguration)	Persists changes in the IBusinessCalendarConfiguration businessCalendarConfiguration.

Method Details

findBusinessCalendarConfiguration

IBusinessCalendarConfiguration findBusinessCalendarConfiguration(String name)

Finds the IBusinessCalendarConfiguration identified by the name. If no IBusinessCalendarConfiguration is stored under that name, null is returned.

Parameters:

name - the unique name of the desired IBusinessCalendarConfiguration. Must not be empty and shorter than 200 characters.

Returns:

the IBusinessCalendarConfiguration identified by the name. Null if none is found.

Throws:

IllegalArgumentException - if name is null or too long.

PersistencyException - if the persistency system access failed.

API:

This public API is available in Java.

createBusinessCalendarConfiguration

IBusinessCalendarConfiguration createBusinessCalendarConfiguration(String name)

Creates a new IBusinessCalendarConfiguration identified by the name. The new IBusinessCalendarConfiguration has the default calendar as parent. Use IBusinessCalendarConfiguration.setParent(IBusinessCalendarConfiguration) to change the parent.

Parameters:

name - the unique name of the desired IBusinessCalendarConfiguration. Must not be empty and shorter than 200 characters.

Returns:

the new IBusinessCalendarConfiguration identified by the name. Never null.

Throws:

IllegalArgumentException - if name is null or too long.

IllegalStateException - if a calendar with the name already exists

PersistencyException - if the persistency system access failed.

API:

This public API is available in Java.

getRootBusinessCalendarConfiguration

IBusinessCalendarConfiguration getRootBusinessCalendarConfiguration()

Returns the default IBusinessCalendarConfiguration for this application. This is the root IBusinessCalendarConfiguration from which all other IBusinessCalendarConfigurations of this application inherit.

Returns:

the default IBusinessCalendarConfiguration for this application. Never null.

Throws:

PersistencyException - if the persistency system access failed.

API:

This public API is available in Java.

getAllBusinessCalendarConfigurations

Tree getAllBusinessCalendarConfigurations()

Returns an Tree containing all IBusinessCalendarConfigurations

Returns:

Tree of IBusinessCalendarConfigurations. Never null.

Throws:

PersistencyException - if the persistency system access failed.

API:

This public API is available in Java.

getAllBusinessCalendarConfigurationsAsList

List<IBusinessCalendarConfiguration> getAllBusinessCalendarConfigurationsAsList()

Returns an List containing all IBusinessCalendarConfigurations

Returns:

List of IBusinessCalendarConfigurations. Never null.

Throws:

PersistencyException - if the persistency system access failed.

API:

This public API is available in Java.

saveBusinessCalendarConfiguration

void saveBusinessCalendarConfiguration(IBusinessCalendarConfiguration businessCalendarConfiguration)

Persists changes in the IBusinessCalendarConfiguration businessCalendarConfiguration.

To create or change a IBusinessCalendarConfiguration, first create the IBusinessCalendarConfiguration using createBusinessCalendarConfiguration(String) or load it using findBusinessCalendarConfiguration(String).

Example:

 IBusinessCalendarConfiguration calendarConfiguration = application.getBusinessCalendarConfiguration("ZugSpecialHolidays");
 calendarConfiguration.getFreeDaysOfYear().add(new FreeDayOfYear(12,8)));
 application.saveBusinessCalendarConfiguration(calendarConfiguration);
 

Parameters:

businessCalendarConfiguration - the businessCalendarConfiguration to persist

Throws:

IllegalArgumentException - if calendarConfiguration is null

PersistencyException - if the persistency system access failed.

API:

This public API is available in Java.

deleteBusinessCalendarConfiguration

void deleteBusinessCalendarConfiguration(IBusinessCalendarConfiguration businessCalendarConfiguration)

Deletes the IBusinessCalendarConfiguration businessCalendarConfiguration. If the configuration is not persisted yet, nothing happens.

Example:
IBusinessCalendarConfiguration configurationToDelete = application.getBusinessCalendarConfiguration(x); application.deleteBusinessCalendarConfiguration(configurationToDelete);

Parameters:

businessCalendarConfiguration - the IBusinessCalendarConfiguration to delete

Throws:

IllegalArgumentException - if calendarConfiguration is null

PersistencyException - if the persistency system access failed.

ch.ivyteam.util.IvyRuntimeException - if the businessCalendarConfiguration is the default IBusinessCalendarConfiguration (see getRootBusinessCalendarConfiguration())

API:

This public API is available in Java.

findBusinessCalendarConfiguration

@Deprecated(since="9.4",
            forRemoval=true)
IBusinessCalendarConfiguration findBusinessCalendarConfiguration(Long id)

Deprecated, for removal: This API element is subject to removal in a future version.

use findBusinessCalendarConfiguration(String) instead

Internal API to get the IBusinessCalendarConfiguration with the id stored in the db.

Parameters:

id -

Returns:

will always return null because calendars are no longer stored in database.

API:

This public API is available in Java.

getBusinessCalendarId

@Deprecated(since="9.4",
            forRemoval=true)
Long getBusinessCalendarId(IBusinessCalendar calendar)

Deprecated, for removal: This API element is subject to removal in a future version.

use IBusinessCalendar.getName() instead to identify a calendar

Internal API to get the id under which the calendar is stored in the db.

Parameters:

calendar - nullable.

Returns:

will always return null because calendars are no longer stored in database.

API:

This public API is available in Java.

getBusinessCalendarId

@Deprecated(since="9.4",
            forRemoval=true)
Long getBusinessCalendarId(String calendarName)

Deprecated, for removal: This API element is subject to removal in a future version.

use calendar name to identify calendars

Internal API to get the id under which the calendar is stored in the db.

Parameters:

calendarName - nullable.

Returns:

will always return null because calendars are no longer stored in database

API:

This public API is available in Java.