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
.Finds theIBusinessCalendarConfiguration
identified by thename
.Returns an Tree containing allIBusinessCalendarConfiguration
sReturns an List containing allIBusinessCalendarConfiguration
sReturns 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 IvyScript and Java. It has the visibility EXPERT.
-
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 IvyScript and Java. It has the visibility EXPERT.
-
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 IvyScript and Java. It has the visibility EXPERT.
-
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 IvyScript and Java. It has the visibility EXPERT.
-
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 IvyScript and Java. It has the visibility EXPERT.
-
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 IvyScript and Java. It has the visibility EXPERT.
-
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 IvyScript and Java. It has the visibility EXPERT.
-