Interface RecurringEventEnablerCalendarSession

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

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

    • canLookupRecurringEventEnablerCalendarMappings

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

    • useComparativeRecurringEventEnablerCalendarView

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

    • usePlenaryRecurringEventEnablerCalendarView

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

    • getRecurringEventEnablerIdsByCalendar

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

    • getRecurringEventEnablersByCalendar

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

    • getRecurringEventEnablerIdsByCalendars

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

    • getRecurringEventEnablersByCalendars

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

    • getCalendarIdsByRecurringEventEnabler

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

    • getCalendarsByRecurringEventEnabler

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