Interface CalendaringCycleBatchManager

All Superinterfaces:
AutoCloseable, CalendaringCycleBatchProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable
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

  • Method Details

    • getCyclicEventBatchAdminSession

      CyclicEventBatchAdminSession getCyclicEventBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk cyclic event administration service.
      Returns:
      a CyclicEventBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCyclicEventBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCyclicEventBatchAdmin()} is {@code true} .

    • getCyclicEventBatchAdminSessionForCalendar

      CyclicEventBatchAdminSession getCyclicEventBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk cyclic event administration service for the given calendar.
      Parameters:
      calendarId - the Id of the Calendar
      Returns:
      a CyclicEventBatchAdminSession
      Throws:
      NotFoundException - no Calendar found by the given Id
      NullArgumentException - calendarId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCyclicEventBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCyclicEventBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getCyclicTimePeriodBatchAdminSession

      CyclicTimePeriodBatchAdminSession getCyclicTimePeriodBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk cyclic time period administration service.
      Returns:
      a CyclicTimePeriodBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCyclicTimePeriodBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCyclicTimePeriodBatchAdmin()} is {@code true} .

    • getCyclicTimePeriodBatchAdminSessionForCalendar

      CyclicTimePeriodBatchAdminSession getCyclicTimePeriodBatchAdminSessionForCalendar(Id calendarId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk cyclic time period administration service for the given calendar.
      Parameters:
      calendarId - the Id of the Calendar
      Returns:
      a CyclicTimePeriodBatchAdminSession
      Throws:
      NotFoundException - no Calendar found by the given Id
      NullArgumentException - calendarId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCyclicTimePeriodBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCyclicTimePeriodBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}