Interface PoolProcessorLookupSession

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

This session provides methods for retrieving PoolProcessors .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated distributor view: All pool processor methods in this session operate, retrieve and pertain to pool processors defined explicitly in the current distributor Using an isolated view is useful for managing PoolProcessors with the PoolProcessorAdminSession .
  • federated distributor view: All pool processor methods in this session operate, retrieve and pertain to all pool processors defined in this distributor and any other pool processors implicitly available in this distributor through distributor inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() be have as a radio group and one should be selected before invoking any lookup methods.

  • 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.

    • canLookupPoolProcessors

      boolean canLookupPoolProcessors()
      Tests if this user can perform PoolProcessor lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativePoolProcessorView

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

    • usePlenaryPoolProcessorView

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

    • useActivePoolProcessorView

      void useActivePoolProcessorView()
      Only active poolProcessors are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusPoolProcessorView

      void useAnyStatusPoolProcessorView()
      All active and inactive poolProcessors are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getPoolProcessor

      PoolProcessor getPoolProcessor(Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the PoolProcessor specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned PoolProcessor may have a different Id than requested, such as the case where a duplicate Id was assigned to a PoolProcessor and retai ned for compatibility.
      Parameters:
      poolProcessorId - Id of the PoolProcessor
      Returns:
      the pool processor
      Throws:
      NotFoundException - poolProcessorId not found
      NullArgumentException - poolProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getPoolProcessorsByIds

      PoolProcessorList getPoolProcessorsByIds(IdList poolProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a PoolProcessorList corresponding to the given IdList . In plenary mode, the returned list contains all of the pool processors specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible PoolProcessors may be omi tted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      poolProcessorIds - the list of Ids to retrieve
      Returns:
      the returned PoolProcessor list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - poolProcessorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorsByGenusType

      PoolProcessorList getPoolProcessorsByGenusType(Type poolProcessorGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a PoolProcessorList corresponding to the given pool processor genus Type which does not include pool processors of genus types derived from the specified Type . In plenary mode, the returned list contains all known pool processors or an error results. Otherwise, the returned list may contain only those pool processors that are accessible through this session.
      Parameters:
      poolProcessorGenusType - a pool processor genus type
      Returns:
      the returned PoolProcessor list
      Throws:
      NullArgumentException - poolProcessorGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorsByParentGenusType

      PoolProcessorList getPoolProcessorsByParentGenusType(Type poolProcessorGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a PoolProcessorList corresponding to the given pool processor genus Type and include any additional pool processors with genus types derived from the specified Type . In plenary mode, the returned list contains all known pool processors or an error results. Otherwise, the returned list may contain only those pool processors that are accessible through this session.
      Parameters:
      poolProcessorGenusType - a pool processor genus type
      Returns:
      the returned PoolProcessor list
      Throws:
      NullArgumentException - poolProcessorGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorsByRecordType

      PoolProcessorList getPoolProcessorsByRecordType(Type poolProcessorRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a PoolProcessorList containing the given pool processor record Type . In plenary mode, the returned list contains all known pool processors or an error results. Otherwise, the returned list may contain only those pool processors that are accessible through this session.
      Parameters:
      poolProcessorRecordType - a pool processor record type
      Returns:
      the returned PoolProcessor list
      Throws:
      NullArgumentException - poolProcessorRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessors

      PoolProcessorList getPoolProcessors() throws OperationFailedException, PermissionDeniedException
      Gets all PoolProcessors . In plenary mode, the returned list contains all known pool processors or an error results. Otherwise, the returned list may contain only those pool processors that are accessible through this session.
      Returns:
      a list of PoolProcessors
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.