Interface DispatchEnablerRuleLookupSession

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

This session provides methods to retrieve DispatchEnabler 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 enablers defined explicitly in the current publisher
  • federated publisher view: All 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.

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

    • canLookupDispatchEnablerRules

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

    • useComparativeDispatchEnablerRuleView

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

    • usePlenaryDispatchEnablerRuleView

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

    • getDispatchEnablerIdsForDispatch

      IdList getDispatchEnablerIdsForDispatch(Id dispatchId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchEnabler Ids associated with a Dispatch .
      Parameters:
      dispatchId - Id of the Dispatch
      Returns:
      the dispatch enabler 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.

    • getDispatchEnablersForDispatch

      DispatchEnablerList getDispatchEnablersForDispatch(Id dispatchId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchEnablers associated with a Dispatch .
      Parameters:
      dispatchId - Id of the Dispatch
      Returns:
      the dispatch enablers
      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.

    • getDispatchIdsForDispatchEnabler

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

    • getDispatchesForDispatchEnabler

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