Interface PoolConstrainerDistributorSession

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

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

    • canLookupPoolConstrainerDistributorMappings

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

    • useComparativePoolConstrainerDistributorView

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

    • usePlenaryPoolConstrainerDistributorView

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

    • getPoolConstrainerIdsByDistributor

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

    • getPoolConstrainersByDistributor

      PoolConstrainerList getPoolConstrainersByDistributor(Id distributorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of PoolConstrainers associated with a Distributor .
      Parameters:
      distributorId - Id of the Distributor
      Returns:
      list of related pool constrainers
      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.

    • getPoolConstrainerIdsByDistributors

      IdList getPoolConstrainerIdsByDistributors(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 constrainer Ids
      Throws:
      NullArgumentException - distributorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolConstrainersByDistributors

      PoolConstrainerList getPoolConstrainersByDistributors(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 constrainers
      Throws:
      NullArgumentException - distributorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getDistributorIdsByPoolConstrainer

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

    • getDistributorsByPoolConstrainer

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