Interface BrokerProcessorEnablerLookupSession

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

This session provides methods for retrieving BrokerProcessorEnablers .

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

    • canLookupBrokerProcessorEnablers

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

    • useComparativeBrokerProcessorEnablerView

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

    • usePlenaryBrokerProcessorEnablerView

      void usePlenaryBrokerProcessorEnablerView()
      A complete view of the BrokerProcessorEnabler 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 processor 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.

    • useActiveBrokerProcessorEnablerView

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

    • useAnyStatusBrokerProcessorEnablerView

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

    • getBrokerProcessorEnabler

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

    • getBrokerProcessorEnablersByIds

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

    • getBrokerProcessorEnablersByGenusType

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

    • getBrokerProcessorEnablersByParentGenusType

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

    • getBrokerProcessorEnablersByRecordType

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

    • getBrokerProcessorEnablersOnDate

      BrokerProcessorEnablerList getBrokerProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a BrokerProcessorEnablerList that are effective for the entire given date range but not confined to the date range. In plenary mode, the returned list contains all known brokerProcessorEnablers or an error results. Otherwise, the returned list may contain only those brokerProcessorEnablers that are accessible through this session. In active mode, brokerProcessorEnablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive brokerProcessorEnablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned BrokerProcessorEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorEnablersOnDateWithAgent

      BrokerProcessorEnablerList getBrokerProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a BrokerProcessorEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known brokerProcessorEnablers or an error results. Otherwise, the returned list may contain only those brokerProcessorEnablers that are accessible through this session. In active mode, brokerProcessorEnablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive brokerProcessorEnablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned BrokerProcessorEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBrokerProcessorEnablers

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