Interface RecurringEventCalendarAssignmentSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RecurringEventCalendarAssignmentSession extends OsidSession

This session provides methods to re-assign RecurringEvents to Calendars . A RecurringEvent may map to multiple Calendars and removing the last reference to a RecurringEvent is the equivalent of deleting it. Each Calendar may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of a RecurringEvent to another Calendar is not a copy operation (eg: does not change its Id ).

  • Method Details

    • canAssignRecurringEvents

      boolean canAssignRecurringEvents()
      Tests if this user can alter recurring event/calendar mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignRecurringEventsToCalendar

      boolean canAssignRecurringEventsToCalendar(Id calendarId)
      Tests if this user can alter recurring event/calendar mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Parameters:
      calendarId - the Id of the Calendar
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - calendarId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableCalendarIds

      IdList getAssignableCalendarIds(Id calendarId) throws OperationFailedException
      Gets a list of calendars including and under the given calendar node in which any recurring event can be assigned.
      Parameters:
      calendarId - the Id of the Calendar
      Returns:
      list of assignable calendar Ids
      Throws:
      NullArgumentException - calendarId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableCalendarIdsForRecurringEvent

      IdList getAssignableCalendarIdsForRecurringEvent(Id calendarId, Id recurringEventId) throws OperationFailedException
      Gets a list of calendars including and under the given calendar node in which a specific recurring event can be assigned.
      Parameters:
      calendarId - the Id of the Calendar
      recurringEventId - the Id of the recurringEventId
      Returns:
      list of assignable calendar Ids
      Throws:
      NullArgumentException - calendarId or recurringEventId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignRecurringEventToCalendar

      void assignRecurringEventToCalendar(Id recurringEventId, Id calendarId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing RecurringEvent to a Calendar .
      Parameters:
      recurringEventId - the Id of the RecurringEvent
      calendarId - the Id of the Calendar
      Throws:
      AlreadyExistsException - recurringEventId is already assigned to calendarId
      NotFoundException - recurringEventId or calendarId not found
      NullArgumentException - recurringEventId or calendarId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignRecurringEventFromCalendar

      void unassignRecurringEventFromCalendar(Id recurringEventId, Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a RecurringEvent from a Calendar .
      Parameters:
      recurringEventId - the Id of the RecurringEvent
      calendarId - the Id of the Calendar
      Throws:
      NotFoundException - recurringEventId or calendarId not found or recurringEventId not assigned to calendarId
      NullArgumentException - recurringEventId or calendarId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignRecurringEventToCalendar

      void reassignRecurringEventToCalendar(Id recurringEventId, Id fromCalendarId, Id toCalendarId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a RecurringEvent from one Calendar to another. Mappings to other Calendars are unaffected.
      Parameters:
      recurringEventId - the Id of the RecurringtEvent
      fromCalendarId - the Id of the current Calendar
      toCalendarId - the Id of the destination Calendar
      Throws:
      AlreadyExistsException - recurringEventId already assigned to toCalendarId
      NotFoundException - recurringEventId, fromCalendarId , or toCalendarId not found or recurringEventId not mapped to fromCalendarId
      NullArgumentException - recurringEventId, fromCalendarId , or toCalendarId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.