DepotQuerySession

All Superinterfaces:: AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:: DepotSearchSession

public interface DepotQuerySession extends OsidSession

This session provides methods for searching among Depots. The search query is constructed using the DepotQuery.

Depots may have a query record indicated by their respective record types. The query record is accessed via the DepotQuery.

Like all OsidSessions, DepotQuerySessions are dedicated to single processing threads and a single authenticated user.

Method Summary

Modifier and Type

Method

Description

boolean

canSearchDepots()

Tests if this user can perform Depot searches.

DepotQuery

getDepotQuery()

Gets a depot query.

DepotList

getDepotsByQuery(DepotQuery depotQuery)

Gets a list of Depot objects matching the given depot query.

Methods inherited from interface Closeable
close

Methods inherited from interface OsidSession
close

Methods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatTypes, getLocales, isAuthenticated, startTransaction, supportsTransactions

Method Details
- canSearchDepots
  
  boolean canSearchDepots()
  
  Tests if this user can perform Depot 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.
- getDepotQuery
  
  DepotQuery getDepotQuery()
  
  Gets a depot query.
  
  Returns:
  
  a depot query
  
  Compliance:
  mandatory - This method must be implemented.
- getDepotsByQuery
  
  DepotList getDepotsByQuery(DepotQuery depotQuery) throws OperationFailedException, PermissionDeniedException
  
  Gets a list of Depot objects matching the given depot query.
  
  Parameters:
  
  depotQuery - the depot query
  
  Returns:
  
  the returned DepotList
  
  Throws:
  
  NullArgumentException - depotQuery is null
  
  OperationFailedException - unable to complete request
  
  PermissionDeniedException - authorization failure
  
  UnsupportedException - depotQuery is not of this service
  
  Compliance:
  mandatory - This method must be implemented.