org.osid.workflow

Interface OfficeSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OfficeQuerySession, OsidSession

public interface OfficeSearchSession
extends OfficeQuerySession

This session provides methods for searching among Office objects. 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

Methods

Modifier and Type	Method and 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 org.osid.workflow.OfficeQuerySession

canSearchOffices, getOfficeQuery, getOfficesByQuery

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.