public interface UtilityQuerySession extends OsidSession
This session provides methods for searching Utility
objects. The search query is constructed using the UtilityQuery.
The utility record Type
also specifies the record
for the utility query.
Utilities may have a query record indicated by their respective record
types. The query record is accessed via the UtilityQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchUtilities()
Tests if this user can perform
Utility searches. |
UtilityList |
getUtilitiesByQuery(UtilityQuery utilityQuery)
Gets a list of
Utilities matching the given utility
query. |
UtilityQuery |
getUtilityQuery()
Gets a utility query.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchUtilities()
Utility
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. UtilityQuery getUtilityQuery()
mandatory
- This method must be implemented. UtilityList getUtilitiesByQuery(UtilityQuery utilityQuery) throws OperationFailedException, PermissionDeniedException
Utilities
matching the given utility
query.utilityQuery
- the utility query UtilityList
NullArgumentException
- utilityQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- utilityQuery
is
not of this servicemandatory
- This method must be implemented.