Interface QueueProcessorEnablerLookupSession

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

This session provides methods for retrieving QueueProcessorEnablers .

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

    • canLookupQueueProcessorEnablers

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

    • useComparativeQueueProcessorEnablerView

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

    • usePlenaryQueueProcessorEnablerView

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

    • useActiveQueueProcessorEnablerView

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

    • useAnyStatusQueueProcessorEnablerView

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

    • getQueueProcessorEnabler

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

    • getQueueProcessorEnablersByIds

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

    • getQueueProcessorEnablersByGenusType

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

    • getQueueProcessorEnablersByParentGenusType

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

    • getQueueProcessorEnablersByRecordType

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

    • getQueueProcessorEnablersOnDate

      QueueProcessorEnablerList getQueueProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a QueueProcessorEnablerList 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 queueProcessorEnablers or an error results. Otherwise, the returned list may contain only those queueProcessorEnablers that are accessible through this session. In active mode, queueProcessorEnablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive queueProcessorEnablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned QueueProcessorEnabler 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.

    • getQueueProcessorEnablersOnDateWithAgent

      QueueProcessorEnablerList getQueueProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a QueueProcessorEnablerList 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 queueProcessorEnablers or an error results. Otherwise, the returned list may contain only those queueProcessorEnablers that are accessible through this session. In active mode, queueProcessorEnablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive queueProcessorEnablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned QueueProcessorEnabler 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.

    • getQueueProcessorEnablers

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