Interface QueueConstrainerLookupSession

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

This session provides methods for retrieving QueueConstrainers .

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

    • canLookupQueueConstrainers

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

    • useComparativeQueueConstrainerView

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

    • usePlenaryQueueConstrainerView

      void usePlenaryQueueConstrainerView()
      A complete view of the QueueConstrainer 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 queue 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.

    • useActiveQueueConstrainerView

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

    • useAnyStatusQueueConstrainerView

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

    • getQueueConstrainer

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

    • getQueueConstrainersByIds

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

    • getQueueConstrainersByGenusType

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

    • getQueueConstrainersByParentGenusType

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

    • getQueueConstrainersByRecordType

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

    • getQueueConstrainers

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