Interface SupersedingEventEnablerCalendarSession

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

This session provides methods to retrieve SupersedingEventEnabler to Calendar mappings. A SupersedingEventEnabler may appear in multiple Calendar objects. Each calendar may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupSupersedingEventEnablerCalendarMappings

      boolean canLookupSupersedingEventEnablerCalendarMappings()
      Tests if this user can perform lookups of superseding event enabler/calendar mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeSupersedingEventEnablerCalendarView

      void useComparativeSupersedingEventEnablerCalendarView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenarySupersedingEventEnablerCalendarView

      void usePlenarySupersedingEventEnablerCalendarView()
      A complete view of the SupersedingEventEnabler and Calendar returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getSupersedingEventEnablerIdsByCalendar

      IdList getSupersedingEventEnablerIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of SupersedingEventEnablerIds associated with a Calendar .
      Parameters:
      calendarId - Id of the Calendar
      Returns:
      list of related superseding event enabler Ids
      Throws:
      NotFoundException - calendarId is not found
      NullArgumentException - calendarId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventEnablersByCalendar

      SupersedingEventEnablerList getSupersedingEventEnablersByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of superseding event enablers associated with a Calendar .
      Parameters:
      calendarId - Id of the Calendar
      Returns:
      list of related superseding event enablers
      Throws:
      NotFoundException - calendarId is not found
      NullArgumentException - calendarId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventEnablerIdsByCalendars

      IdList getSupersedingEventEnablerIdsByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of SupersedingEventEnablerIds corresponding to a list of Calendars .
      Parameters:
      calendarIds - list of calendar Ids
      Returns:
      list of superseding event enabler Ids
      Throws:
      NullArgumentException - calendarIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventEnablersByCalendars

      SupersedingEventEnablerList getSupersedingEventEnablersByCalendars(IdList calendarIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of superseding event enablers corresponding to a list of Calendars .
      Parameters:
      calendarIds - list of calendar Ids
      Returns:
      list of superseding event enablers
      Throws:
      NullArgumentException - calendarIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCalendarIdsBySupersedingEventEnabler

      IdList getCalendarIdsBySupersedingEventEnabler(Id supersedingEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Calendar Ids mapped to a SupersedingEventEnabler .
      Parameters:
      supersedingEventEnablerId - Id of a SupersedingEventEnabler
      Returns:
      list of calendars
      Throws:
      NotFoundException - supersedingEventEnablerId is not found
      NullArgumentException - supersedingEventEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCalendarsBySupersedingEventEnabler

      CalendarList getCalendarsBySupersedingEventEnabler(Id supersedingEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Calendars mapped to a SupersedingEventEnabler .
      Parameters:
      supersedingEventEnablerId - Id of a SupersedingEventEnabler
      Returns:
      list of calendars
      Throws:
      NotFoundException - supersedingEventEnablerId is not found
      NullArgumentException - supersedingEventEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.