Interface DispatchEnablerLookupSession

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

This session provides methods for retrieving DispatchEnablers .

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 publisher view: All dispatch enabler methods in this session operate, retrieve and pertain to dispatch enablers defined explicitly in the current publisher Using an isolated view is useful for managing DispatchEnablers with the DispatchEnablerAdminSession .
  • federated publisher view: All dispatch enabler methods in this session operate, retrieve and pertain to all dispatch enablers defined in this publisher and any other dispatch enablers implicitly available in this publisher through publisher inheritence.

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 useFederatedPublisherView() and useIsolatedPublisherView() beha ve as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getPublisherId

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

    • getPublisher

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

    • canLookupDispatchEnablers

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

    • useComparativeDispatchEnablerView

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

    • usePlenaryDispatchEnablerView

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

    • useFederatedPublisherView

      void useFederatedPublisherView()
      Federates the view for methods in this session. A federated view will include dispatch enablers in publishers which are children of this publisher in the publisher hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedPublisherView

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

    • getDispatchEnabler

      DispatchEnabler getDispatchEnabler(Id dispatchEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned DispatchEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a DispatchEnabler and r etained for compatibility.
      Parameters:
      dispatchEnablerId - Id of the DispatchEnabler
      Returns:
      the dispatch enabler
      Throws:
      NotFoundException - dispatchEnablerId not found
      NullArgumentException - dispatchEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getDispatchEnablersByIds

      DispatchEnablerList getDispatchEnablersByIds(IdList dispatchEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a DispatchEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the dispatch 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 DispatchEnablers may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      dispatchEnablerIds - the list of Ids to retrieve
      Returns:
      the returned DispatchEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - dispatchEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchEnablersByGenusType

      DispatchEnablerList getDispatchEnablersByGenusType(Type dispatchEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a DispatchEnablerList corresponding to the given dispatch enabler genus Type which does not include dispatch enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known dispatch enablers or an error results. Otherwise, the returned list may contain only those dispatch enablers that are accessible through this session.
      Parameters:
      dispatchEnablerGenusType - a dispatch enabler genus type
      Returns:
      the returned DispatchEnabler list
      Throws:
      NullArgumentException - dispatchEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchEnablersByParentGenusType

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

    • getDispatchEnablersByRecordType

      DispatchEnablerList getDispatchEnablersByRecordType(Type dispatchEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a DispatchEnablerList containing the given dispatch enabler record Type . In plenary mode, the returned list contains all known dispatch enablers or an error results. Otherwise, the returned list may contain only those dispatch enablers that are accessible through this session.
      Parameters:
      dispatchEnablerRecordType - a dispatch enabler record type
      Returns:
      the returned DispatchEnabler list
      Throws:
      NullArgumentException - dispatchEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchEnablers

      DispatchEnablerList getDispatchEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all DispatchEnablers . In plenary mode, the returned list contains all known dispatch enablers or an error results. Otherwise, the returned list may contain only those dispatch enablers that are accessible through this session.
      Returns:
      a list of DispatchEnablers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.