Interface BrokerEnablerLookupSession

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

This session provides methods for retrieving BrokerEnablers .

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

    • canLookupBrokerEnablers

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

    • useComparativeBrokerEnablerView

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

    • usePlenaryBrokerEnablerView

      void usePlenaryBrokerEnablerView()
      A complete view of the BrokerEnabler 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 broker 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.

    • getBrokerEnabler

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

    • getBrokerEnablersByIds

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

    • getBrokerEnablersByGenusType

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

    • getBrokerEnablersByParentGenusType

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

    • getBrokerEnablersByRecordType

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

    • getBrokerEnablers

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