Interface OffsetEventLookupSession

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

This session provides methods for retrieving OffsetEvents .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated calendar view: All offset event methods in this session operate, retrieve and pertain to offset events defined explicitly in the current calendar. Using an isolated view is useful for managing events with the OffsetEventAdminSession .
  • federated calendar view: All offset event methods in this session operate, retrieve and pertain to all offset events defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.
  • active offset event view: All offset event lookup methods return active offset events.
  • any status offset event view: Offset events of any active or inactive status are returned from methods.

  • 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 associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupOffsetEvents

      boolean canLookupOffsetEvents()
      Tests if this user can perform OffsetEvent lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeOffsetEventView

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

    • usePlenaryOffsetEventView

      void usePlenaryOffsetEventView()
      A complete view of the OffsetEvent 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 offset events 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.

    • useActiveOffsetEventView

      void useActiveOffsetEventView()
      Only active offset events are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusOffsetEventView

      void useAnyStatusOffsetEventView()
      All active and inactive offset events are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getOffsetEvent

      OffsetEvent getOffsetEvent(Id offsetEventId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the OffsetEvent specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned OffsetEvent may have a different Id than requested, such as the case where a duplicate Id was assigned to an OffsetEvent and retained for compatibility. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
      Parameters:
      offsetEventId - Id of the OffsetEvent
      Returns:
      the offset event
      Throws:
      NotFoundException - offsetEventId not found
      NullArgumentException - offsetEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getOffsetEventsByIds

      OffsetEventList getOffsetEventsByIds(IdList offsetEventIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an OffsetEventList corresponding to the given IdList . In plenary mode, the returned list contains all of the offset events specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible OffsetEvents may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
      Parameters:
      offsetEventIds - the list of Ids to retrieve
      Returns:
      the returned OffsetEvent list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - offsetEventIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOffsetEventsByGenusType

      OffsetEventList getOffsetEventsByGenusType(Type offsetEventGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an OffsetEventList corresponding to the given offset event genus Type which does not include offset events of genus types derived from the specified Type . In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
      Parameters:
      offsetEventGenusType - an offset event genus type
      Returns:
      the returned OffsetEvent list
      Throws:
      NullArgumentException - offsetEventGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOffsetEventsByParentGenusType

      OffsetEventList getOffsetEventsByParentGenusType(Type offsetEventGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an OffsetEventList corresponding to the given offset event genus Type and include any additional offset event with genus types derived from the specified Type . In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
      Parameters:
      offsetEventGenusType - an offset event genus type
      Returns:
      the returned OffsetEvent list
      Throws:
      NullArgumentException - offsetEventGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOffsetEventsByRecordType

      OffsetEventList getOffsetEventsByRecordType(Type offsetEventrecordType) throws OperationFailedException, PermissionDeniedException
      Gets an OffsetEventList containing the given offset event record Type . In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
      Parameters:
      offsetEventrecordType - an offset event record type
      Returns:
      the returned OffsetEvent list
      Throws:
      NullArgumentException - offsetEventRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getOffsetEventsByEvent

      OffsetEventList getOffsetEventsByEvent(Id eventId) throws OperationFailedException, PermissionDeniedException
      Gets the OffsetEvents using the given event as a start or ending offset. In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
      Parameters:
      eventId - Id of the related event
      Returns:
      the offset events
      Throws:
      NullArgumentException - eventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getOffsetEvents

      OffsetEventList getOffsetEvents() throws OperationFailedException, PermissionDeniedException
      Gets all OffsetEvents . In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
      Returns:
      an OffsetEventList
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.