Interface PoolConstrainerEnablerDistributorSession

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

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

    • canLookupPoolConstrainerEnablerDistributorMappings

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

    • useComparativePoolConstrainerEnablerDistributorView

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

    • usePlenaryPoolConstrainerEnablerDistributorView

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

    • getPoolConstrainerEnablerIdsByDistributor

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

    • getPoolConstrainerEnablersByDistributor

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

    • getPoolConstrainerEnablerIdsByDistributors

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

    • getPoolConstrainerEnablersByDistributors

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

    • getDistributorIdsByPoolConstrainerEnabler

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

    • getDistributorsByPoolConstrainerEnabler

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