Interface RecurringEventEnablerRuleLookupSession

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

This session provides methods to retrieve RecurringEventEnabler to RecurringEvent mappings. An Calendar with multiple RecurringEventEnablers means any positive rule evaluation across the enablers result in an effective RecurringEvent .

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
  • isolated calendar view: All methods in this session operate, retrieve and pertain recurring event enablers defined explicitly in the current calendar
  • federated calendar view: All methods in this session operate, retrieve and pertain to all recurring event enablers defined in this calendar and any other recurring event enablers implicitly available in this calendar through calendar inheritence.

  • Method Details

    • getCalendarId

      Id getCalendarId()
      Gets the Calendar Id associated with this session.
      Returns:
      the Calendar Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCalendar

      Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
      Gets the Calendar associated with this session.
      Returns:
      the calendar
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupRecurringEventEnablerRules

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

    • useComparativeRecurringEventEnablerRuleView

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

    • usePlenaryRecurringEventEnablerRuleView

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

    • useFederatedCalendarView

      void useFederatedCalendarView()
      Federates the view for methods in this session. A federated view will include recurring event enablers in calendars which are children of this calendar in the calendar hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCalendarView

      void useIsolatedCalendarView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.
      Compliance:
      mandatory - This method is must be implemented.

    • getRecurringEventEnablerIdsForRecurringEvent

      IdList getRecurringEventEnablerIdsForRecurringEvent(Id recurringEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RecurringEventEnabler Id associated with a RecurringEvent .
      Parameters:
      recurringEventId - Id of the RecurringEvent
      Returns:
      the recurring event enabler Ids
      Throws:
      NotFoundException - recurringEventId is not found
      NullArgumentException - recurringEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventEnablersForRecurringEvent

      RecurringEventEnablerList getRecurringEventEnablersForRecurringEvent(Id recurringEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RecurringEventEnablers associated with a RecurringEvent .
      Parameters:
      recurringEventId - Id of the RecurringEvent
      Returns:
      the recurring event enablers
      Throws:
      NotFoundException - recurringEventId is not found
      NullArgumentException - recurringEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventIdsForRecurringEventEnabler

      IdList getRecurringEventIdsForRecurringEventEnabler(Id recurringEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RecurringEvent Ids mapped to a RecurringEventEnabler .
      Parameters:
      recurringEventEnablerId - Id of a RecurringEventEnabler
      Returns:
      list of recurring event Ids
      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.

    • getRecurringEventsForRecurringEventEnabler

      RecurringEventList getRecurringEventsForRecurringEventEnabler(Id recurringEventEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the RecurringEvents mapped to a RecurringEventEnabler .
      Parameters:
      recurringEventEnablerId - Id of a RecurringEventEnabler
      Returns:
      list of recurring events
      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.