public interface CalendaringBatchManager extends OsidManager, CalendaringBatchProfile
The calendaring batch manager provides access to calendaring batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
EventBatchAdminSession:
a session to create,
modify and delete events in bulk RecurringEventBatchAdminSession:
a session to
create, modify and delete recurring events in bulk OffsetEventBatchSession:
a session to create,
modify and delete offset events in bulk ScheduleBatchAdminSession:
a session to create,
modify and delete schedules in bulk ScheduleSlotBatchSession:
a session to create,
modify and delete schedule slots in bulk CommitmentBatchAdminSession:
a session to create,
modify and delete commitments in bulk TimePeriodBatchAdminSession:
a session to create,
modify and delete time periods in bulk CalendarBatchAdminSession:
a session to create,
modify and delete calendars in bulk Modifier and Type | Method and Description |
---|---|
CalendarBatchAdminSession |
getCalendarBatchAdminSession()
Gets the
OsidSession associated with the bulk calendar
administration service. |
CommitmentBatchAdminSession |
getCommitmentBatchAdminSession()
Gets the
OsidSession associated with the bulk
commitment administration service. |
CommitmentBatchAdminSession |
getCommitmentBatchAdminSessionForCalendar(Id calendarId)
Gets the
OsidSession associated with the bulk
commitment administration service for the given calendar. |
EventBatchAdminSession |
getEventBatchAdminSession()
Gets the
OsidSession associated with the bulk event
administration service. |
EventBatchAdminSession |
getEventBatchAdminSessionForCalendar(Id calendarId)
Gets the
OsidSession associated with the bulk event
administration service for the given calendar. |
OffsetEventBatchAdminSession |
getOffsetEventBatchAdminSession()
Gets the
OsidSession associated with the bulk offset
event administration service. |
OffsetEventBatchAdminSession |
getOffsetEventBatchAdminSessionForCalendar(Id calendarId)
Gets the
OsidSession associated with the bulk offset
event administration service for the given calendar |
RecurringEventBatchAdminSession |
getRecurringEventBatchAdminSession()
Gets the
OsidSession associated with the bulk recurring
event administration service. |
RecurringEventBatchAdminSession |
getRecurringEventBatchAdminSessionForCalendar(Id calendarId)
Gets the
OsidSession associated with the bulk recurring
event administration service for the given calendar. |
ScheduleBatchAdminSession |
getScheduleBatchAdminSession()
Gets the
OsidSession associated with the bulk schedule
administration service. |
ScheduleBatchAdminSession |
getScheduleBatchAdminSessionForCalendar(Id calendarId)
Gets the
OsidSession associated with the bulk schedule
administration service for the given calendar. |
ScheduleSlotBatchAdminSession |
getScheduleSlotBatchAdminSession()
Gets the
OsidSession associated with the bulk schedule
slot administration service. |
ScheduleSlotBatchAdminSession |
getScheduleSlotBatchAdminSessionForCalendar(Id calendarId)
Gets the
OsidSession associated with the bulk schedule
slot administration service for the given calendar. |
TimePeriodBatchAdminSession |
getTimePeriodBatchAdminSession()
Gets the
OsidSession associated with the bulk time
period administration service. |
TimePeriodBatchAdminSession |
getTimePeriodBatchAdminSessionForCalendar(Id calendarId)
Gets the
OsidSession associated with the bulk time
period administration service for the given calendar. |
changeBranch, initialize, rollbackService
close
supportsCalendarBatchAdmin, supportsCommitmentBatchAdmin, supportsEventBatchAdmin, supportsOffsetEventBatchAdmin, supportsRecurringEventBatchAdmin, supportsScheduleBatchAdmin, supportsScheduleSlotBatchAdmin, supportsTimePeriodBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
EventBatchAdminSession getEventBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk event
administration service. EventBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEventBatchAdmin()
is false
optional
- This method must be implemented if
supportsEventBatchAdmin()
is true.
EventBatchAdminSession getEventBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk event
administration service for the given calendar.calendarId
- the Id
of the Calendar
EventBatchAdminSession
NotFoundException
- no Calendar
found by
the given Id
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEventBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEventBatchAdmin()
and
supportsVisibleFederation()
are true
RecurringEventBatchAdminSession getRecurringEventBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk recurring
event administration service. RecurringEventBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecurringEventBatchAdmin()
is false
optional
- This method must be implemented if
supportsRecurringEventBatchAdmin()
is true.
RecurringEventBatchAdminSession getRecurringEventBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk recurring
event administration service for the given calendar.calendarId
- the Id
of the Calendar
RecurringEventBatchAdminSession
NotFoundException
- no Calendar
found by
the given Id
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRecurringEventBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRecurringEventBatchAdmin()
and
supportsVisibleFederation()
are true
OffsetEventBatchAdminSession getOffsetEventBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk offset
event administration service. OffsetEventBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOffsetEventBatchAdmin()
is false
optional
- This method must be implemented if
supportsOffsetEventBatchAdmin()
is true.
OffsetEventBatchAdminSession getOffsetEventBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk offset
event administration service for the given calendarcalendarId
- the Id
of the Calendar
OffsetEventBatchAdminSession
NotFoundException
- no Calendar
found by
the given Id
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOffsetEventBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOffsetEventBatchAdmin()
and
supportsVisibleFederation()
are true
ScheduleBatchAdminSession getScheduleBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk schedule
administration service. ScheduleBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsScheduleBatchAdmin()
is false
optional
- This method must be implemented if
supportsScheduleBatchAdmin()
is true.
ScheduleBatchAdminSession getScheduleBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk schedule
administration service for the given calendar.calendarId
- the Id
of the Calendar
ScheduleBatchAdminSession
NotFoundException
- no Calendar
found by
the given Id
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsScheduleBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsScheduleBatchAdmin()
and
supportsVisibleFederation()
are true
ScheduleSlotBatchAdminSession getScheduleSlotBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk schedule
slot administration service. ScheduleSlotBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsScheduleSlotBatchAdmin()
is false
optional
- This method must be implemented if
supportsScheduleSlotBatchAdmin()
is true.
ScheduleSlotBatchAdminSession getScheduleSlotBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk schedule
slot administration service for the given calendar.calendarId
- the Id
of the Calendar
ScheduleSlotBatchAdminSession
NotFoundException
- no Calendar
found by
the given Id
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsScheduleSlotBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsScheduleSlotBatchAdmin()
and
supportsVisibleFederation()
are true
CommitmentBatchAdminSession getCommitmentBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
commitment administration service. CommitmentBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCommitmentBatchAdmin()
is false
optional
- This method must be implemented if
supportsCommitmentBatchAdmin()
is true.
CommitmentBatchAdminSession getCommitmentBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
commitment administration service for the given calendar.calendarId
- the Id
of the Calendar
CommitmentBatchAdminSession
NotFoundException
- no Calendar
found by
the given Id
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCommitmentBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCommitmentBatchAdmin()
and
supportsVisibleFederation()
are true
TimePeriodBatchAdminSession getTimePeriodBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk time
period administration service. TimePeriodBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTimePeriodBatchAdmin()
is false
optional
- This method must be implemented if
supportsTimePeriodBatchAdmin()
is true.
TimePeriodBatchAdminSession getTimePeriodBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk time
period administration service for the given calendar.calendarId
- the Id
of the Calendar
TimePeriodBatchAdminSession
NotFoundException
- no Calendar
found by
the given Id
NullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsTimePeriodBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsTimePeriodBatchAdmin()
and
supportsVisibleFederation()
are true
CalendarBatchAdminSession getCalendarBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk calendar
administration service. CalendarBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCalendarBatchAdmin()
is false
optional
- This method must be implemented if
supportsCalendarBatchAdmin()
is true.