Interface ProvisionEnablerRuleLookupSession

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

This session provides methods to retrieve ProvisionEnabler to Provision mappings.

Th is 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 methods in this session operate, retrieve and pertain to provision enablers defined explicitly in the current distributor
  • federated distributor view: All 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.

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

    • canLookupProvisionEnablerRules

      boolean canLookupProvisionEnablerRules()
      Tests if this user can perform lookups of provision enabler/provision mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeProvisionEnablerRuleView

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

    • usePlenaryProvisionEnablerRuleView

      void usePlenaryProvisionEnablerRuleView()
      A complete view of the ProvisionEnabler and Provision 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.

    • getProvisionEnablerIdsForProvision

      IdList getProvisionEnablerIdsForProvision(Id provisionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProvisionEnabler Ids associated with a Provision .
      Parameters:
      provisionId - Id of the Provision
      Returns:
      the provision enabler Ids
      Throws:
      NotFoundException - provisionId is not found
      NullArgumentException - provisionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionEnablersForProvision

      ProvisionEnablerList getProvisionEnablersForProvision(Id provisionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProvisionEnablers associated with a Provision .
      Parameters:
      provisionId - Id of the Provision
      Returns:
      the provision enablers
      Throws:
      NotFoundException - provisionId is not found
      NullArgumentException - provisionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionIdsForProvisionEnabler

      IdList getProvisionIdsForProvisionEnabler(Id provisionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Provision Ids mapped to a ProvisionEnabler .
      Parameters:
      provisionEnablerId - Id of a ProvisionEnabler
      Returns:
      list of provision Ids
      Throws:
      NotFoundException - provisionEnablerId is not found
      NullArgumentException - provisionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionsForProvisionEnabler

      ProvisionList getProvisionsForProvisionEnabler(Id provisionEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Provisions mapped to a ProvisionEnabler .
      Parameters:
      provisionEnablerId - Id of a ProvisionEnabler
      Returns:
      list of provisions
      Throws:
      NotFoundException - provisionEnablerId is not found
      NullArgumentException - provisionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.