Interface OffsetEventEnablerCalendarSession

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

This session provides methods to retrieve OffsetEventEnabler to Calendar mappings. An OffsetEventEnabler 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

    • canLookupOffsetEventEnablerCalendarMappings

      boolean canLookupOffsetEventEnablerCalendarMappings()
      Tests if this user can perform lookups of offset 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.

    • useComparativeOffsetEventEnablerCalendarView

      void useComparativeOffsetEventEnablerCalendarView()
      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.

    • usePlenaryOffsetEventEnablerCalendarView

      void usePlenaryOffsetEventEnablerCalendarView()
      A complete view of the OffsetEventEnabler 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.

    • getOffsetEventEnablerIdsByCalendar

      IdList getOffsetEventEnablerIdsByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of OffsetEventEnablerIds associated with a Calendar .
      Parameters:
      calendarId - Id of the Calendar
      Returns:
      list of related offset 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.

    • getOffsetEventEnablersByCalendar

      OffsetEventEnablerList getOffsetEventEnablersByCalendar(Id calendarId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of offset event enablers associated with a Calendar .
      Parameters:
      calendarId - Id of the Calendar
      Returns:
      list of related offset 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.

    • getOffsetEventEnablerIdsByCalendars

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

    • getOffsetEventEnablersByCalendars

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

    • getCalendarIdsByOffsetEventEnabler

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

    • getCalendarsByOffsetEventEnabler

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