AgencyQuerySession

All Superinterfaces:: AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:: AgencySearchSession

public interface AgencyQuerySession extends OsidSession

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

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

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

Method Summary

Modifier and Type

Method

Description

boolean

canSearchAgencies()

Tests if this user can perform Agency searches.

AgencyList

getAgenciesByQuery(AgencyQuery agencyQuery)

Gets a list of Agency objects matching the given agency query.

AgencyQuery

getAgencyQuery()

Gets an agency 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
- canSearchAgencies
  
  boolean canSearchAgencies()
  
  Tests if this user can perform Agency 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 app
  
  Returns:
  
  false if search methods are not authorized, true otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getAgencyQuery
  
  AgencyQuery getAgencyQuery()
  
  Gets an agency query.
  
  Returns:
  
  an agency query
  
  Compliance:
  mandatory - This method must be implemented.
- getAgenciesByQuery
  
  AgencyList getAgenciesByQuery(AgencyQuery agencyQuery) throws OperationFailedException, PermissionDeniedException
  
  Gets a list of Agency objects matching the given agency query.
  
  Parameters:
  
  agencyQuery - the agency query
  
  Returns:
  
  the returned AgencyList
  
  Throws:
  
  NullArgumentException - agencyQuery is null
  
  OperationFailedException - unable to complete request
  
  PermissionDeniedException - authorization failure
  
  UnsupportedException - agencyQuery is not of this service
  
  Compliance:
  mandatory - This method must be implemented.