Interface ProvisionableEnablerRuleLookupSession

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

This session provides methods to retrieve ProvisionableEnabler to Provisionable 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 provisionable enablers defined explicitly in the current distributor
  • federated distributor view: All methods in this session operate, retrieve and pertain to all provisionable enablers defined in this distributor and any other provisionable 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.

    • canLookupProvisionableEnablerRules

      boolean canLookupProvisionableEnablerRules()
      Tests if this user can perform lookups of provisionable enabler/provisionable 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.

    • useComparativeProvisionableEnablerRuleView

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

    • usePlenaryProvisionableEnablerRuleView

      void usePlenaryProvisionableEnablerRuleView()
      A complete view of the ProvisionableEnabler and 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 provisionable 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.

    • getProvisionableEnablerIdsForProvisionable

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

    • getProvisionableEnablersForProvisionable

      ProvisionableEnablerList getProvisionableEnablersForProvisionable(Id provisionableId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProvisionableEnablers associated with a Provisionable .
      Parameters:
      provisionableId - Id of the Provisionable
      Returns:
      the provisionable enablers
      Throws:
      NotFoundException - provisionableId is not found
      NullArgumentException - provisionableId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionableIdsForProvisionableEnabler

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

    • getProvisionablesForProvisionableEnabler

      ProvisionableList getProvisionablesForProvisionableEnabler(Id provisionableEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Provisionables mapped to a ProvisionableEnabler .
      Parameters:
      provisionableEnablerId - Id of a ProvisionableEnabler
      Returns:
      list of provisionables
      Throws:
      NotFoundException - provisionableEnablerId is not found
      NullArgumentException - provisionableEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.