Interface ResourceQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ResourceSearchSession
public interface ResourceQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated bin view: searches include resources in bins of which this bin is an ancestor in the bin hierarchy
  • isolated bin view: searches are restricted to resources in this bin

Resources may have a resource record indicated by their respective record types. The resource query record is accessed via the ResourceQuery .

  • Method Details

    • getBinId

      Id getBinId()
      Gets the Bin Id associated with this session.
      Returns:
      the Bin Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getBin

      Bin getBin() throws OperationFailedException, PermissionDeniedException
      Gets the Bin associated with this session.
      Returns:
      the Bin associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchResources

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

    • useFederatedBinView

      void useFederatedBinView()
      Federates the view for methods in this session. A federated view will include resources in bins which are children of this bin in the bin hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBinView

      void useIsolatedBinView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.
      Compliance:
      mandatory - This method is must be implemented.

    • getResourceQuery

      ResourceQuery getResourceQuery()
      Gets a resource query. The returned query will not have an extension query.
      Returns:
      the resource query
      Compliance:
      mandatory - This method must be implemented.

    • getResourcesByQuery

      ResourceList getResourcesByQuery(ResourceQuery resourceQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Resources matching the given resource query.
      Parameters:
      resourceQuery - the resource query
      Returns:
      the returned ResourceList
      Throws:
      NullArgumentException - resourceQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - resourceQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.