Interface BrokerConstrainerLookupSession

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

This session provides methods for retrieving BrokerConstrainers .

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

    • canLookupBrokerConstrainers

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

    • useComparativeBrokerConstrainerView

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

    • usePlenaryBrokerConstrainerView

      void usePlenaryBrokerConstrainerView()
      A complete view of the BrokerConstrainer 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 constrainers 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.

    • useActiveBrokerConstrainerView

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

    • useAnyStatusBrokerConstrainerView

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

    • getBrokerConstrainer

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

    • getBrokerConstrainersByIds

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

    • getBrokerConstrainersByGenusType

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

    • getBrokerConstrainersByParentGenusType

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

    • getBrokerConstrainersByRecordType

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

    • getBrokerConstrainers

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