Interface PoolEnablerRuleLookupSession

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

This session provides methods to retrieve PoolEnabler to Pool mappings.

Th is 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 pool enablers defined explicitly in the current distributor
  • federated distributor view: All methods in this session operate, retrieve and pertain to all pool enablers defined in this distributor and any other pool 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.

    • canLookupPoolEnablerRules

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

    • useComparativePoolEnablerRuleView

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

    • usePlenaryPoolEnablerRuleView

      void usePlenaryPoolEnablerRuleView()
      A complete view of the PoolEnabler and Pool 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 pool 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.

    • getPoolEnablerIdsForPool

      IdList getPoolEnablerIdsForPool(Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the PoolEnabler Ids associated with a Pool .
      Parameters:
      poolId - Id of the Pool
      Returns:
      the pool enabler Ids
      Throws:
      NotFoundException - poolId is not found
      NullArgumentException - poolId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolEnablersForPool

      PoolEnablerList getPoolEnablersForPool(Id poolId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the PoolEnablers associated with a Pool .
      Parameters:
      poolId - Id of the Pool
      Returns:
      the pool enablers
      Throws:
      NotFoundException - poolId is not found
      NullArgumentException - poolId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolIdsForPoolEnabler

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

    • getPoolsForPoolEnabler

      PoolList getPoolsForPoolEnabler(Id poolEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Pools mapped to a PoolEnabler .
      Parameters:
      poolEnablerId - Id of a PoolEnabler
      Returns:
      list of pools
      Throws:
      NotFoundException - poolEnablerId is not found
      NullArgumentException - poolEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.