Interface PoolConstrainerLookupSession

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

This session provides methods for retrieving PoolConstrainers .

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 cosntrainer methods in this session operate, retrieve and pertain to pool constrainers defined explicitly in the current distributor Using an isolated view is useful for managing PoolConstrainers with the PoolConstrainerAdminSession .
  • federated distributor view: All pool constrainer methods in this session operate, retrieve and pertain to all pool constrainers defined in this distributor and any other pool constrainers 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.

    • canLookupPoolConstrainers

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

    • useComparativePoolConstrainerView

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

    • usePlenaryPoolConstrainerView

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

    • useActivePoolConstrainerView

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

    • useAnyStatusPoolConstrainerView

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

    • getPoolConstrainer

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

    • getPoolConstrainersByIds

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

    • getPoolConstrainersByGenusType

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

    • getPoolConstrainersByParentGenusType

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

    • getPoolConstrainersByRecordType

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

    • getPoolConstrainers

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