Interface CommitmentEnablerCalendarSession

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

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

    • canLookupCommitmentEnablerCalendarMappings

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

    • useComparativeCommitmentEnablerCalendarView

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

    • usePlenaryCommitmentEnablerCalendarView

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

    • getCommitmentEnablerIdsByCalendar

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

    • getCommitmentEnablersByCalendar

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

    • getCommitmentEnablerIdsByCalendars

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

    • getCommitmentEnablersByCalendars

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

    • getCalendarIdsByCommitmentEnabler

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

    • getCalendarsByCommitmentEnabler

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