Interface PoolEnablerLookupSession

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

This session provides methods for retrieving PoolEnablers .

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 enabler methods in this session operate, retrieve and pertain to pool enablers defined explicitly in the current distributor Using an isolated view is useful for managing PoolEnablers with the PoolEnablerAdminSession .
  • federated distributor view: All pool enabler 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.

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.

    • canLookupPoolEnablers

      boolean canLookupPoolEnablers()
      Tests if this user can perform PoolEnabler 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.

    • useComparativePoolEnablerView

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

    • usePlenaryPoolEnablerView

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

    • getPoolEnabler

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

    • getPoolEnablersByIds

      PoolEnablerList getPoolEnablersByIds(IdList poolEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a PoolEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the pool enablers 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 PoolEnablers may be omi tted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      poolEnablerIds - the list of Ids to retrieve
      Returns:
      the returned PoolEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - poolEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPoolEnablersByGenusType

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

    • getPoolEnablersByParentGenusType

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

    • getPoolEnablersByRecordType

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

    • getPoolEnablers

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