Interface PoolProcessorDistributorSession

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

This session provides methods to retrieve PoolProcessor to Distributor mappings. A PoolProcessor 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

    • canLookupPoolProcessorDistributorMappings

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

    • useComparativePoolProcessorDistributorView

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

    • usePlenaryPoolProcessorDistributorView

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

    • getPoolProcessorIdsByDistributor

      IdList getPoolProcessorIdsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of PoolProcessor Ids associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related pool processor 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.

    • getPoolProcessorsByDistributor

      PoolProcessorList getPoolProcessorsByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of PoolProcessors associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related pool processors
      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.

    • getPoolProcessorIdsByDistributors

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

    • getPoolProcessorsByDistributors

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

    • getDistributorIdsByPoolProcessor

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

    • getDistributorsByPoolProcessor

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