Interface PoolProcessorEnablerDistributorSession

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

This session provides methods to retrieve PoolprocessorEnabler to Distributor mappings. A PoolProcessorEnabler may appear in multiple Distributors. Each d istributor may have its own authorizations governing who is allowed to look at it.

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

  • Method Details

    • canLookupPoolProcessorEnablerDistributorMappings

      boolean canLookupPoolProcessorEnablerDistributorMappings()
      Tests if this user can perform lookups of pool processor enabler/distributor 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. T his 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.

    • useComparativePoolProcessorEnablerDistributorView

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

    • usePlenaryPoolProcessorEnablerDistributorView

      void usePlenaryPoolProcessorEnablerDistributorView()
      A complete view of the PoolProcessorEnabler and Distributor 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.

    • getPoolProcessorEnablerIdsByDistributor

      IdList getPoolProcessorEnablerIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of PoolProcessorEnablerIds associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related pool processor enabler Ids
      Throws:
      NotFoundException - distributorId is not found
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorEnablersByDistributor

      PoolProcessorEnablerList getPoolProcessorEnablersByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of PoolProcessorEnablers associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related pool processor enablers
      Throws:
      NotFoundException - distributorId is not found
      NullArgumentException - distributorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorEnablerIdsByDistributors

      IdList getPoolProcessorEnablerIdsByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of PoolProcessorEnablerIds corresponding to a list of Distributors .
      Parameters:
      distributorIds - list of distributor Ids
      Returns:
      list of pool processor enabler Ids
      Throws:
      NullArgumentException - distributorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorEnablersByDistributors

      PoolProcessorEnablerList getPoolProcessorEnablersByDistributors(IdList distributorIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of PoolProcessorEnablers corresponding to a list of Distributors .
      Parameters:
      distributorIds - list of distributor Ids
      Returns:
      list of pool processor enablers
      Throws:
      NullArgumentException - distributorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDistributorIdsByPoolProcessorEnabler

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

    • getDistributorsByPoolProcessorEnabler

      DistributorList getDistributorsByPoolProcessorEnabler(Id poolProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Distributors mapped to a PoolProcessorEnabler .
      Parameters:
      poolProcessorEnablerId - Id of a PoolProcessorEnabler
      Returns:
      list of distributors
      Throws:
      NotFoundException - poolProcessorEnablerId is not found
      NullArgumentException - poolProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.