Interface DispatchProcessorEnablerRuleLookupSession

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

This session provides methods to retrieve DispatchProcessorEnabler to DispatchProcessor mappin gs.

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

    • canLookupDispatchProcessorEnablerRules

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

    • useComparativeDispatchProcessorEnablerRuleView

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

    • usePlenaryDispatchProcessorEnablerRuleView

      void usePlenaryDispatchProcessorEnablerRuleView()
      A complete view of the DispatchProcessorEnabler and 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 processor 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.

    • getDispatchProcessorEnablerIdsForDispatch

      IdList getDispatchProcessorEnablerIdsForDispatch(Id dispatchProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchProcessorEnablerIds associated with a DispatchProcessor .
      Parameters:
      dispatchProcessorId - Id of the DispatchProcessor
      Returns:
      the dispatch processor enabler 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.

    • getDispatchProcessorEnablersForDispatchProcessor

      DispatchProcessorEnablerList getDispatchProcessorEnablersForDispatchProcessor(Id dispatchProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchProcessorEnablers associated with a DispatchProcessor .
      Parameters:
      dispatchProcessorId - Id of the DispatchProcessor
      Returns:
      the dispatch processor enablers
      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.

    • getDispatchProcessorIdsForDispatchProcessorEnabler

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

    • getDispatchProcessorsForDispatchProcessorEnabler

      DispatchProcessorList getDispatchProcessorsForDispatchProcessorEnabler(Id dispatchProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the DispatchProcessors mapped to a DispatchProcessorEnabler .
      Parameters:
      dispatchProcessorEnablerId - Id of a DispatchprocessorEnabler
      Returns:
      list of dispatch processors
      Throws:
      NotFoundException - dispatchProcessorEnablerId is not found
      NullArgumentException - dispatchProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.