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.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchAgencies()
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 false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. AgencyQuery getAgencyQuery()
mandatory
- This method must be implemented. AgencyList getAgenciesByQuery(AgencyQuery agencyQuery) throws OperationFailedException, PermissionDeniedException
Agency
objects matching the given agency
query.agencyQuery
- the agency query AgencyList
NullArgumentException
- agencyQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- agencyQuery
is
not of this servicemandatory
- This method must be implemented.