Interface OfficeSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OfficeQuerySession, OsidSession, OsidSession

public interface OfficeSearchSession
extends OfficeQuerySession

This session provides methods for searching among Offices . The search query is constructed using the OfficeQuery .

getOfficesByQuery() is the basic search method and returns a list of Offices . A more advanced search may be performed with getOfficesBySearch() .It accepts an OfficeSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getOfficesBySearch() returns an OfficeSearchResults that can be used to access the resulting OfficeList or be used to perform a search within the result set through OfficeSearch .

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

Method Summary

Modifier and Type	Method	Description
OfficeQuery	getOfficeQueryFromInspector(OfficeQueryInspector officeQueryInspector)	Gets an office query from an inspector.
OfficeSearchResults	getOfficesBySearch(OfficeQuery officeQuery, OfficeSearch officeSearch)	Gets the search results matching the given search query using the given search.
OfficeSearch	getOfficeSearch()	Gets an office search.
OfficeSearchOrder	getOfficeSearchOrder()	Gets an office search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OfficeQuerySession

canSearchOffices, getOfficeQuery, getOfficesByQuery

Modifier and Type	Method	Description
boolean	canSearchOffices()	Tests if this user can perform Office searches.
OfficeQuery	getOfficeQuery()	Gets an office query.
OfficeList	getOfficesByQuery(OfficeQuery officeQuery)	Gets a list of Offices matching the given office query.

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.

Method Details

getOfficeSearch

OfficeSearch getOfficeSearch()

Gets an office search.

Returns:

the office search

Compliance:

mandatory - This method must be implemented.

getOfficeSearchOrder

OfficeSearchOrder getOfficeSearchOrder()

Gets an office search order. The OfficeSearchOrder is supplied to an OfficeSearch to specify the ordering of results.

Returns:

the office search order

Compliance:

mandatory - This method must be implemented.

getOfficesBySearch

OfficeSearchResults getOfficesBySearch(OfficeQuery officeQuery,
 OfficeSearch officeSearch)
                                throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

officeQuery - the office query

officeSearch - the office search

Returns:

the returned search results

Throws:

NullArgumentException - officeQuery or officeSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - officeQuery or officeSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getOfficeQueryFromInspector

OfficeQuery getOfficeQueryFromInspector(OfficeQueryInspector officeQueryInspector)

Gets an office query from an inspector. The inspector is available from an OfficeSearchResults .

Parameters:

officeQueryInspector - an office query inspector

Returns:

the office query

Throws:

NullArgumentException - officeQueryInspector is null

UnsupportedException - officeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.