Interface SupersedingEventEnablerLookupSession

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

This session provides methods for retrieving SupersedingEventEnablers .

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 superseding event enabler methods in this session operate, retrieve and pertain to superseding event enablers defined explicitly in the current calendar. Using an isolated view is useful for managing SupersedingEventEnablers with the SupersedingEventEnablerAdminSession .
  • federated calendar view: All superseding event enabler methods in this session operate, retrieve and pertain to all superseding event enablers defined in this calendar and any other superseding event enablers implicitly available in this calendar through calendar inheritence.
  • active superseding event enabler view: All superseding event enabler lookup methods return active superseding event enablers.
  • any status superseding event enabler view: superseding event enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

  • 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.

    • canLookupSupersedingEventEnablers

      boolean canLookupSupersedingEventEnablers()
      Tests if this user can perform SupersedingEventEnablers 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.

    • useComparativeSupersedingEventEnablerView

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

    • usePlenarySupersedingEventEnablerView

      void usePlenarySupersedingEventEnablerView()
      A complete view of the SupersedingEventEnabler 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 superseding 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.

    • useActiveSupersedingEventEnablerView

      void useActiveSupersedingEventEnablerView()
      Only active superseding event enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusSupersedingEventEnablerView

      void useAnyStatusSupersedingEventEnablerView()
      All active and inactive superseding event enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getSupersedingEventEnabler

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

    • getSupersedingEventEnablersByIds

      SupersedingEventEnablerList getSupersedingEventEnablersByIds(IdList supersedingEventEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a SupersedingEventEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the superseding event enablers 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 SupersedingEventEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, supseding event enablers are returned that are currently active. In any status mode, active and inactive superseding event enablers are returned.
      Parameters:
      supersedingEventEnablerIds - the list of Ids to retrieve
      Returns:
      the returned SupersedingEventEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - supersedingEventEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventEnablersByGenusType

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

    • getSupersedingEventEnablersByParentGenusType

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

    • getSupersedingEventEnablersByRecordType

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

    • getSupersedingEventEnablersOnDate

      SupersedingEventEnablerList getSupersedingEventEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a SupersedingEventEnablerList effectiveduring the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known superseding event enablers or an error results. Otherwise, the returned list may contain only those superseding event enablers that are accessible through this session. In active mode, supseding event enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive superseding event enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned SupersedingEventEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventEnablersOnDateWithAgent

      SupersedingEventEnablerList getSupersedingEventEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a SupersedingEventEnablerList effectiveduring the entire given date range inclusive but not confined to the date range evaluated against the given agent. In plenary mode, the returned list contains all known superseding event enablers or an error results. Otherwise, the returned list may contain only those superseding event enablers that are accessible through this session. In active mode, supseding event enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive superseding event enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned SupersedingEventEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agent, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventEnablers

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