Interface BrokerProcessorEnablerRuleLookupSession

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

This session provides methods to retrieve BrokerProcessorEnabler to BrokerProcessor mappings .

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 distributor view: All methods in this session operate, retrieve and pertain to broker processor enablers defined explicitly in the current distributor
  • federated distributor view: All methods in this session operate, retrieve and pertain to all broker processor enablers defined in this distributor and any other broker processor enablers implicitly available in this distributor through distributor inheritence.

  • Method Details

    • getDistributorId

      Id getDistributorId()
      Gets the Distributor Id associated with this session.
      Returns:
      the Distributor Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getDistributor

      Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
      Gets the Distributor associated with this session.
      Returns:
      the distributor
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupBrokerProcessorEnablerRules

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

    • useComparativeBrokerProcessorEnablerRuleView

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

    • usePlenaryBrokerProcessorEnablerRuleView

      void usePlenaryBrokerProcessorEnablerRuleView()
      A complete view of the BrokerProcessorEnabler and BrokerProcessor 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.

    • useFederatedDistributorView

      void useFederatedDistributorView()
      Federates the view for methods in this session. A federated view will include broker processor enablers in distributors which are children of this distributor in the distributor hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDistributorView

      void useIsolatedDistributorView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.
      Compliance:
      mandatory - This method is must be implemented.

    • getBrokerProcessorEnablerIdsForBroker

      IdList getBrokerProcessorEnablerIdsForBroker(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BrokerProcessorEnablerIds associated with a BrokerProcessor .
      Parameters:
      brokerProcessorId - Id of the BrokerProcessor
      Returns:
      the broker processor enabler Ids
      Throws:
      NotFoundException - brokerProcessorId is not found
      NullArgumentException - brokerProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorEnablersForBrokerProcessor

      BrokerProcessorEnablerList getBrokerProcessorEnablersForBrokerProcessor(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BrokerProcessorEnablers associated with a BrokerProcessor .
      Parameters:
      brokerProcessorId - Id of the BrokerProcessor
      Returns:
      the broker processor enablers
      Throws:
      NotFoundException - brokerProcessorId is not found
      NullArgumentException - brokerProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorIdsForBrokerProcessorEnabler

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

    • getBrokerProcessorsForBrokerProcessorEnabler

      BrokerProcessorList getBrokerProcessorsForBrokerProcessorEnabler(Id brokerProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the BrokerProcessors mapped to a BrokerProcessorEnabler .
      Parameters:
      brokerProcessorEnablerId - Id of a BrokerprocessorEnabler
      Returns:
      list of broker processors
      Throws:
      NotFoundException - brokerProcessorEnablerId is not found
      NullArgumentException - brokerProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.