Interface ProvisionableEnablerLookupSession

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

This session provides methods for retrieving ProvisionableEnablers .

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

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.

    • canLookupProvisionableEnablers

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

    • useComparativeProvisionableEnablerView

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

    • usePlenaryProvisionableEnablerView

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

    • getProvisionableEnabler

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

    • getProvisionableEnablersByIds

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

    • getProvisionableEnablersByGenusType

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

    • getProvisionableEnablersByParentGenusType

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

    • getProvisionableEnablersByRecordType

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

    • getProvisionableEnablers

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