Interface QueueConstrainerEnablerLookupSession

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

This session provides methods for retrieving QueueConstrainerEnablers .

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

    • canLookupQueueConstrainerEnablers

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

    • useComparativeQueueConstrainerEnablerView

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

    • usePlenaryQueueConstrainerEnablerView

      void usePlenaryQueueConstrainerEnablerView()
      A complete view of the QueueConstrainerEnabler 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 constrainer 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.

    • useActiveQueueConstrainerEnablerView

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

    • useAnyStatusQueueConstrainerEnablerView

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

    • getQueueConstrainerEnabler

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

    • getQueueConstrainerEnablersByIds

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

    • getQueueConstrainerEnablersByGenusType

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

    • getQueueConstrainerEnablersByParentGenusType

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

    • getQueueConstrainerEnablersByRecordType

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

    • getQueueConstrainerEnablersOnDate

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

    • getQueueConstrainerEnablersOnDateWithAgent

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

    • getQueueConstrainerEnablers

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