Interface DispatchProcessorLookupSession

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

This session provides methods for retrieving DispatchProcessors .

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 processor methods in this session operate, retrieve and pertain to dispatch processors defined explicitly in the current publisher Using an isolated view is useful for managing DispatchProcessors with the DispatchProcessorAdminSession .
  • federated publisher view: All dispatch processor methods in this session operate, retrieve and pertain to all dispatch processors defined in this publisher and any other dispatch processors 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.

    • canLookupDispatchProcessors

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

    • useComparativeDispatchProcessorView

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

    • usePlenaryDispatchProcessorView

      void usePlenaryDispatchProcessorView()
      A complete view of the DispatchProcessor 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 processors 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.

    • getDispatchProcessor

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

    • getDispatchProcessorsByIds

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

    • getDispatchProcessorsByGenusType

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

    • getDispatchProcessorsByParentGenusType

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

    • getDispatchProcessorsByRecordType

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

    • getDispatchProcessors

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