Interface DispatchConstrainerRuleLookupSession

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

This session provides methods to retrieve DispatchConstrainer 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 constrainers defined explicitly in the current publisher
  • federated publisher view: All methods in this session operate, retrieve and pertain to all dispatch constrainers defined in this publisher and any other dispatch constrainers 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.

    • canLookupDispatchConstrainerRules

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

    • useComparativeDispatchConstrainerRuleView

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

    • usePlenaryDispatchConstrainerRuleView

      void usePlenaryDispatchConstrainerRuleView()
      A complete view of the DispatchConstrainer 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 constrainers 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.

    • getDispatchConstrainerIdsForDispatch

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

    • getDispatchConstrainersForDispatch

      DispatchConstrainerList getDispatchConstrainersForDispatch(Id dispatchId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchConstrainers associated with a Dispatch .
      Parameters:
      dispatchId - Id of the Dispatch
      Returns:
      the dispatch constrainers
      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.

    • getDispatchIdsForDispatchConstrainer

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

    • getDispatchesForDispatchConstrainer

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