Interface BrokerProcessorLookupSession

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

This session provides methods for retrieving BrokerProcessors .

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

    • canLookupBrokerProcessors

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

    • useComparativeBrokerProcessorView

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

    • usePlenaryBrokerProcessorView

      void usePlenaryBrokerProcessorView()
      A complete view of the BrokerProcessor 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 processors 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.

    • useActiveBrokerProcessorView

      void useActiveBrokerProcessorView()
      Only active brokerProcessors are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusBrokerProcessorView

      void useAnyStatusBrokerProcessorView()
      All active and inactive brokerProcessors are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getBrokerProcessor

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

    • getBrokerProcessorsByIds

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

    • getBrokerProcessorsByGenusType

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

    • getBrokerProcessorsByParentGenusType

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

    • getBrokerProcessorsByRecordType

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

    • getBrokerProcessors

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