Interface UtilitySearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, UtilityQuerySession

public interface UtilitySearchSession
extends UtilityQuerySession

This session provides methods for searching Utility objects. The search query is constructed using the UtilityQuery . The utility record Type also specifies the recod for the utility query.

getUtilitiesByQuery() is the basic search method and returns a list of Utility elements. A more advanced search may be performed with getUtilitiesBySearch() .It accepts a UtilitySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getUtilitiesBySearch() returns a UtilitySearchResults that can be used to access the resulting UtilityList or be used to perform a search within the result set through UtilitySearch .

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.

Method Summary

Modifier and Type	Method	Description
UtilitySearchResults	getUtilitiesBySearch(UtilityQuery utilityQuery, UtilitySearch utilitySearch)	Gets the search results matching the given search.
UtilityQuery	getUtilityQueryFromInspector(UtilityQueryInspector utilityQueryInspector)	Gets a utility query from an inspector.
UtilitySearch	getUtilitySearch()	Gets a utility search.
UtilitySearchOrder	getUtilitySearchOrder()	Gets a utility search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface UtilityQuerySession

canSearchUtilities, getUtilitiesByQuery, getUtilityQuery

Modifier and Type	Method	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.

Method Details

getUtilitySearch

UtilitySearch getUtilitySearch()

Gets a utility search.

Returns:

the utility search

Compliance:

mandatory - This method must be implemented.

getUtilitySearchOrder

UtilitySearchOrder getUtilitySearchOrder()

Gets a utility search order. The UtilitySearchOrder is supplied to a UtilitySearch to specify the ordering of results.

Returns:

the utility search order

Compliance:

mandatory - This method must be implemented.

getUtilitiesBySearch

UtilitySearchResults getUtilitiesBySearch(UtilityQuery utilityQuery,
 UtilitySearch utilitySearch)
                                   throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

utilityQuery - the utility query

utilitySearch - the utility search

Returns:

the utility search results

Throws:

NullArgumentException - utilityQuery or utilitySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - utilityQuery or utilitySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getUtilityQueryFromInspector

UtilityQuery getUtilityQueryFromInspector(UtilityQueryInspector utilityQueryInspector)

Gets a utility query from an inspector. The inspector is available from a UtilitySearchResults .

Parameters:

utilityQueryInspector - a utility query inspector

Returns:

the utility query

Throws:

NullArgumentException - utilityQueryInspector is null

UnsupportedException - utilityQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.