Interface QueueConstrainerEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
QueueConstrainerEnablerSearchSession
public interface QueueConstrainerEnablerQuerySession extends OsidSession

This session provides methods for searching among QueueConstrainerEnabler objects. The search query is constructed using the QueueConstrainerEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated distributor view: searches include queue constrainer enablers in distributors of which this distributor is an ancestor in the distributor hierarchy
  • isolated distributor view: searches are restricted to queue constrainer enablers in this distributor

Queue constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the QueueConstrainerEnablerQuery.

  • 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.

    • canSearchQueueConstrainerEnablers

      boolean canSearchQueueConstrainerEnablers()
      Tests if this user can perform QueueConstrainerEnabler searches. 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 not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method 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 searches to this distributor only.
      Compliance:
      mandatory - This method is must be implemented.

    • getQueueConstrainerEnablerQuery

      QueueConstrainerEnablerQuery getQueueConstrainerEnablerQuery()
      Gets a queue constrainer enabler query.
      Returns:
      the queue constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerEnablersByQuery

      QueueConstrainerEnablerList getQueueConstrainerEnablersByQuery(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of QueueConstrainerEnablers matching the given search.
      Parameters:
      queueConstrainerEnablerQuery - the queue constrainer enabler query
      Returns:
      the returned QueueConstrainerEnablerList
      Throws:
      NullArgumentException - queueConstrainerEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueConstrainerEnablerQuery did not originate from getQueueConstrainerEnablerQuery()
      Compliance:
      mandatory - This method must be implemented.