Interface IBusinessCalendarSettings
Reads, writes, creates and deletes IBusinessCalendarConfiguration
s
Each IApplication
has its own IBusinessCalendarSettings
(see IApplication.getBusinessCalendarSettings()
).
- API:
- This is a public API.
-
Method Summary
Modifier and TypeMethodDescriptionCreates a newIBusinessCalendarConfiguration
identified by thename
.void
deleteBusinessCalendarConfiguration
(IBusinessCalendarConfiguration businessCalendarConfiguration) Deletes theIBusinessCalendarConfiguration
businessCalendarConfiguration
.Deprecated, for removal: This API element is subject to removal in a future version.Finds theIBusinessCalendarConfiguration
identified by thename
.Returns an Tree containing allIBusinessCalendarConfiguration
sReturns an List containing allIBusinessCalendarConfiguration
sgetBusinessCalendarId
(IBusinessCalendar calendar) Deprecated, for removal: This API element is subject to removal in a future version.useIBusinessCalendar.getName()
instead to identify a calendargetBusinessCalendarId
(String calendarName) Deprecated, for removal: This API element is subject to removal in a future version.use calendar name to identify calendarsReturns the defaultIBusinessCalendarConfiguration
for this application.void
saveBusinessCalendarConfiguration
(IBusinessCalendarConfiguration businessCalendarConfiguration) Persists changes in theIBusinessCalendarConfiguration
businessCalendarConfiguration
.
-
Method Details
-
findBusinessCalendarConfiguration
Finds theIBusinessCalendarConfiguration
identified by thename
. If noIBusinessCalendarConfiguration
is stored under thatname
, null is returned.- Parameters:
name
- the unique name of the desiredIBusinessCalendarConfiguration
. Must not be empty and shorter than 200 characters.- Returns:
- the
IBusinessCalendarConfiguration
identified by thename
. Null if none is found. - Throws:
IllegalArgumentException
- ifname
is null or too long.PersistencyException
- if the persistency system access failed.- API:
- This public API is available in Java.
-
createBusinessCalendarConfiguration
Creates a newIBusinessCalendarConfiguration
identified by thename
. The newIBusinessCalendarConfiguration
has the default calendar as parent. UseIBusinessCalendarConfiguration.setParent(IBusinessCalendarConfiguration)
to change the parent.- Parameters:
name
- the unique name of the desiredIBusinessCalendarConfiguration
. Must not be empty and shorter than 200 characters.- Returns:
- the new
IBusinessCalendarConfiguration
identified by the name. Never null. - Throws:
IllegalArgumentException
- ifname
is null or too long.IllegalStateException
- if a calendar with thename
already existsPersistencyException
- if the persistency system access failed.- API:
- This public API is available in Java.
-
getRootBusinessCalendarConfiguration
IBusinessCalendarConfiguration getRootBusinessCalendarConfiguration()Returns the defaultIBusinessCalendarConfiguration
for this application. This is the rootIBusinessCalendarConfiguration
from which all otherIBusinessCalendarConfiguration
s 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 allIBusinessCalendarConfiguration
s- Returns:
- Tree of
IBusinessCalendarConfiguration
s. 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 allIBusinessCalendarConfiguration
s- Returns:
- List of
IBusinessCalendarConfiguration
s. 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 theIBusinessCalendarConfiguration
usingcreateBusinessCalendarConfiguration(String)
or load it usingfindBusinessCalendarConfiguration(String)
.
Example:
IBusinessCalendarConfiguration
calendarConfiguration = application.getBusinessCalendarConfiguration("ZugSpecialHolidays"); calendarConfiguration.getFreeDaysOfYear().add(newFreeDayOfYear
(12,8))); application.saveBusinessCalendarConfiguration(calendarConfiguration);- Parameters:
businessCalendarConfiguration
- the businessCalendarConfiguration to persist- Throws:
IllegalArgumentException
- if calendarConfiguration is nullPersistencyException
- 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
- theIBusinessCalendarConfiguration
to delete- Throws:
IllegalArgumentException
- if calendarConfiguration is nullPersistencyException
- if the persistency system access failed.ch.ivyteam.util.IvyRuntimeException
- if thebusinessCalendarConfiguration
is the defaultIBusinessCalendarConfiguration
(seegetRootBusinessCalendarConfiguration()
)- 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.usefindBusinessCalendarConfiguration(String)
insteadInternal API to get theIBusinessCalendarConfiguration
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, for removal: This API element is subject to removal in a future version.useIBusinessCalendar.getName()
instead to identify a calendarInternal 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, for removal: This API element is subject to removal in a future version.use calendar name to identify calendarsInternal 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.
-
findBusinessCalendarConfiguration(String)
instead