Interface CalendaringBatchManager

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

  • Method Details

    • getEventBatchAdminSession

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

    • getEventBatchAdminSessionForCalendar

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

    • getRecurringEventBatchAdminSession

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

    • getRecurringEventBatchAdminSessionForCalendar

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

    • getOffsetEventBatchAdminSession

      OffsetEventBatchAdminSession getOffsetEventBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk offset event administration service.
      Returns:
      an OffsetEventBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsOffsetEventBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOffsetEventBatchAdmin()} is {@code true} .

    • getOffsetEventBatchAdminSessionForCalendar

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

    • getScheduleBatchAdminSession

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

    • getScheduleBatchAdminSessionForCalendar

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

    • getScheduleSlotBatchAdminSession

      ScheduleSlotBatchAdminSession getScheduleSlotBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk schedule slot administration service.
      Returns:
      a ScheduleSlotBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsScheduleSlotBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsScheduleSlotBatchAdmin()} is {@code true} .

    • getScheduleSlotBatchAdminSessionForCalendar

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

    • getCommitmentBatchAdminSession

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

    • getCommitmentBatchAdminSessionForCalendar

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

    • getTimePeriodBatchAdminSession

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

    • getTimePeriodBatchAdminSessionForCalendar

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

    • getCalendarBatchAdminSession

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