Interface ProvisionableLookupSession

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

This session defines methods for retrieving provisionables.

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
  • isolated distributor view: All provisionable methods in this session operate, retrieve and pertain to provisionables defined explicitly in the current distributor. Using an isolated view is useful for managing Provisionables with the ProvisionableAdminSession .
  • federated distributor view: All provisionable lookup methods in this session operate, retrieve and pertain to all provisionables defined in this distributor and any other provisionables implicitly available in this distributor through distributor inheritence.
  • effective provisionable view: All provisionable lookup methods return provisionables where the current date falls in between the effective dates inclusive.
  • any effective provisionable view: provisionables of any effective date are returned from methods.

The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking any lookup methods.

Provisionables may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the provisionables.

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

    • canLookupProvisionables

      boolean canLookupProvisionables()
      Tests if this user can perform Provisionable 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 not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeProvisionableView

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

    • usePlenaryProvisionableView

      void usePlenaryProvisionableView()
      A complete view of the Provisionable 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 provisionables 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 retrievals to this distributor only.
      Compliance:
      mandatory - This method is must be implemented.

    • useEffectiveProvisionableView

      void useEffectiveProvisionableView()
      Only provisionables whose effective dates are current are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectiveProvisionableView

      void useAnyEffectiveProvisionableView()
      All provisionables of any effective dates are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getProvisionable

      Provisionable getProvisionable(Id provisionableId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Provisionable specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Provisionable may have a different Id than requested, such as the case where a duplicate Id was assigned to a Provisionable and retained for compatibility. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      provisionableId - the Id of the Provisionable to retrieve
      Returns:
      the returned Provisionable
      Throws:
      NotFoundException - no Provisionable found with the given Id
      NullArgumentException - provisionableId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesByIds

      ProvisionableList getProvisionablesByIds(IdList provisionableIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a ProvisionableList corresponding to the given IdList . In plenary mode, the returned list contains all of the provisionables 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 Provisionables may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      provisionableIds - the list of Ids to retrieve
      Returns:
      the returned Provisionable list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - provisionableIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesByGenusType

      ProvisionableList getProvisionablesByGenusType(Type provisionableGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a ProvisionableList corresponding to the given provisionable genus Type which does not include provisionables of types derived from the specified Type . In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      provisionableGenusType - a provisionable genus type
      Returns:
      the returned Provisionable list
      Throws:
      NullArgumentException - provisionableGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesByParentGenusType

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

    • getProvisionablesByRecordType

      ProvisionableList getProvisionablesByRecordType(Type provisionableRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a ProvisionableList containing the given provisionable record Type . In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      provisionableRecordType - a provisionable record type
      Returns:
      the returned Provisionable list
      Throws:
      NullArgumentException - provisionableRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesOnDate

      ProvisionableList getProvisionablesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of provisionables effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned Provisionable list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesForResource

      ProvisionableList getProvisionablesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a list of provisionables for a resource. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Provisionable list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesForResourceOnDate

      ProvisionableList getProvisionablesForResourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of provisionables for a resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      from - start of date range
      to - end of date range
      Returns:
      the returned Provisionable list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesForPool

      ProvisionableList getProvisionablesForPool(Id poolId) throws OperationFailedException, PermissionDeniedException
      Gets a list of provisionables for a pool. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      poolId - a pool Id
      Returns:
      the returned Provisionable list
      Throws:
      NullArgumentException - poolId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesForPoolOnDate

      ProvisionableList getProvisionablesForPoolOnDate(Id poolId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of provisionables effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      poolId - a pool Id
      from - start of date range
      to - end of date range
      Returns:
      the returned Provisionable list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - poolId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesForResourceAndPool

      ProvisionableList getProvisionablesForResourceAndPool(Id resourceId, Id poolId) throws OperationFailedException, PermissionDeniedException
      Gets a list of provisionables for a resource and pool. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      poolId - a pool Id
      Returns:
      the returned Provisionable list
      Throws:
      NullArgumentException - resourceId or poolId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionablesForResourceAndPoolOnDate

      ProvisionableList getProvisionablesForResourceAndPoolOnDate(Id resourceId, Id poolId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of provisionables effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known provisionables or an error results. Otherwise, the returned list may contain only those provisionables that are accessible through this session. In effective mode, provisionables are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective provisionables and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      poolId - a pool Id
      from - start of date range
      to - end of date range
      Returns:
      the returned Provisionable list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, poolId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionables

      ProvisionableList getProvisionables() throws OperationFailedException, PermissionDeniedException
      Gets all provisionables. In plenary mode, the returned list contains all of the provisionables including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Provisionables may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, provisionables are returned that are currently effective. In any effective mode, effective provisionables and those currently expired are returned.
      Returns:
      the returned Provisionable list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.