public interface CalendaringCycleBatchManager extends OsidManager, CalendaringCycleBatchProfile
The calendaring cycle batch manager provides access to calendaring cycle batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
CyclicEventBatchAdminSession:
a session to create,
modify and delete cyclic events in bulk CyclicTimePeriodBatchSession:
a session to create,
modify and delete cyclic time periods in bulk Modifier and Type | Method and Description |
---|---|
CyclicEventBatchAdminSession |
getCyclicEventBatchAdminSession()
Gets the
OsidSession associated with the bulk cyclic
event administration service. |
CyclicEventBatchAdminSession |
getCyclicEventBatchAdminSessionForCalendar(Id calendarId)
Gets the
OsidSession associated with the bulk cyclic
event administration service for the given calendar. |
CyclicTimePeriodBatchAdminSession |
getCyclicTimePeriodBatchAdminSession()
Gets the
OsidSession associated with the bulk cyclic
time period administration service. |
CyclicTimePeriodBatchAdminSession |
getCyclicTimePeriodBatchAdminSessionForCalendar(Id calendarId)
Gets the
OsidSession associated with the bulk cyclic
time period administration service for the given calendar. |
changeBranch, initialize, rollbackService
close
supportsCyclicEventBatchAdmin, supportsCyclicTimePeriodBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CyclicEventBatchAdminSession getCyclicEventBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk cyclic
event administration service. CyclicEventBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCyclicEventBatchAdmin()
is false
optional
- This method must be implemented if
supportsCyclicEventBatchAdmin()
is true.
CyclicEventBatchAdminSession getCyclicEventBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk cyclic
event administration service for the given calendar.calendarId
- the Id
of the Calendar
CyclicEventBatchAdminSession
NotFoundException
- no Calendar
found by
the given Id
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCyclicEventBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCyclicEventBatchAdmin()
and
supportsVisibleFederation()
are true
CyclicTimePeriodBatchAdminSession getCyclicTimePeriodBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk cyclic
time period administration service. CyclicTimePeriodBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCyclicTimePeriodBatchAdmin()
is false
optional
- This method must be implemented if
supportsCyclicTimePeriodBatchAdmin()
is
true.
CyclicTimePeriodBatchAdminSession getCyclicTimePeriodBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk cyclic
time period administration service for the given calendar.calendarId
- the Id
of the Calendar
CyclicTimePeriodBatchAdminSession
NotFoundException
- no Calendar
found by
the given Id
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCyclicTimePeriodBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCyclicTimePeriodBatchAdmin()
and
supportsVisibleFederation()
are true