Interface DispatchProcessorRuleLookupSession

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

This session provides methods to retrieve DispatchProcessor to Dispatch mappings.

Th is 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 publisher view: All methods in this session operate, retrieve and pertain to dispatch processoras defined explicitly in the current publisher
  • federated publisher view: All 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.

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

    • canLookupDispatchProcessorRules

      boolean canLookupDispatchProcessorRules()
      Tests if this user can perform lookups of dispatch processor/dispatch 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.

    • useComparativeDispatchProcessorRuleView

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

    • usePlenaryDispatchProcessorRuleView

      void usePlenaryDispatchProcessorRuleView()
      A complete view of the DispatchProcessor and Dispatch 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.

    • getDispatchProcessorIdsForDispatch

      IdList getDispatchProcessorIdsForDispatch(Id dispatchId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchProcessor Ids associated with a Dispatch .
      Parameters:
      dispatchId - Id of the Dispatch
      Returns:
      the dispatch processor Ids
      Throws:
      NotFoundException - dispatchId is not found
      NullArgumentException - dispatchId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorsForDispatch

      DispatchProcessorList getDispatchProcessorsForDispatch(Id dispatchId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchProcessors associated with a Dispatch .
      Parameters:
      dispatchId - Id of the Dispatch
      Returns:
      the dispatch processors
      Throws:
      NotFoundException - dispatchId is not found
      NullArgumentException - dispatchId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchIdsForDispatchProcessor

      IdList getDispatchIdsForDispatchProcessor(Id dispatchProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Dispatch Ids mapped to a DispatchProcessor .
      Parameters:
      dispatchProcessorId - Id of a DispatchProcessor
      Returns:
      list of dispatch Ids
      Throws:
      NotFoundException - dispatchProcessorId is not found
      NullArgumentException - dispatchProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchesForDispatchProcessor

      DispatchList getDispatchesForDispatchProcessor(Id dispatchProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Dispatches mapped to a DispatchProcessor .
      Parameters:
      dispatchProcessorId - Id of a DispatchProcessor
      Returns:
      list of dispatches
      Throws:
      NotFoundException - dispatchProcessorId is not found
      NullArgumentException - dispatchProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.