Interface ProvisionEnablerLookupSession

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

This session provides methods for retrieving ProvisionEnablers .

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

    • canLookupProvisionEnablers

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

    • useComparativeProvisionEnablerView

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

    • usePlenaryProvisionEnablerView

      void usePlenaryProvisionEnablerView()
      A complete view of the ProvisionEnabler 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 provision 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.

    • getProvisionEnabler

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

    • getProvisionEnablersByIds

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

    • getProvisionEnablersByGenusType

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

    • getProvisionEnablersByParentGenusType

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

    • getProvisionEnablersByRecordType

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

    • getProvisionEnablers

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