OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.FrontOfficeSearchSession
Implementsosid.tracking.FrontOfficeQuerySession
Description

This session provides methods for searching among FrontOffice objects. The search query is constructed using the FrontOfficeQuery.

getFrontOfficesByQuery() is the basic search method and returns a list of FrontOffices. A more advanced search may be performed with getFrontOfficesBySearch(). It accepts a FrontOfficeSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getFrontOfficesBySearch() returns a FrontOfficeSearchResults that can be used to access the resulting FrontOfficeList or be used to perform a search within the result set through FrontOfficeSearch.

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

MethodgetFrontOfficeSearch
Description

Gets a front office search.

Returnosid.tracking.FrontOfficeSearchthe front office search
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficeSearchOrder
Description

Gets a front office search order. The FrontOfficeSearchOrder is supplied to a FrontOfficeSearch to specify the ordering of results.

Returnosid.tracking.FrontOfficeSearchOrderthe front office search order
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficesBySearch
Description

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

Parametersosid.tracking.FrontOfficeQueryfrontOfficeQuerythe front office query
osid.tracking.FrontOfficeSearchfrontOfficeSearchthe front office search
Returnosid.tracking.FrontOfficeSearchResultsthe returned search results
ErrorsNULL_ARGUMENT frontOfficeQuery or frontOfficeSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED frontOfficeQuery or frontOfficeSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficeQueryFromInspector
Description

Gets a front office query from an inspector. The inspector is available from a FrontOfficeSearchResults.

Parametersosid.tracking.FrontOfficeQueryInspectorfrontOfficeQueryInspectora front office query inspector
Returnosid.tracking.FrontOfficeQuerythe front office query
ErrorsNULL_ARGUMENT frontOfficeQueryInspector is null
UNSUPPORTED frontOfficeQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.