Interface QueueProcessorLookupSession

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

This session provides methods for retrieving QueueProcessors .

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

    • canLookupQueueProcessors

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

    • useComparativeQueueProcessorView

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

    • usePlenaryQueueProcessorView

      void usePlenaryQueueProcessorView()
      A complete view of the QueueProcessor 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 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.

    • useActiveQueueProcessorView

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

    • useAnyStatusQueueProcessorView

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

    • getQueueProcessor

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

    • getQueueProcessorsByIds

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

    • getQueueProcessorsByGenusType

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

    • getQueueProcessorsByParentGenusType

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

    • getQueueProcessorsByRecordType

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

    • getQueueProcessors

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