OSID - osid.workflow.OfficeSearchSession Service Interface Definition

Interface	osid.workflow.OfficeSearchSession
Implements	`osid.workflow.OfficeQuerySession`
Description	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	getOfficeSearch
Description	Gets an office search.
Return	`osid.workflow.OfficeSearch`		the office search
Compliance	`mandatory`		This method must be implemented.
Method	getOfficeSearchOrder
Description	Gets an office search order. The `OfficeSearchOrder` is supplied to an `OfficeSearch` to specify the ordering of results.
Return	`osid.workflow.OfficeSearchOrder`		the office search order
Compliance	`mandatory`		This method must be implemented.
Method	getOfficesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.workflow.OfficeQuery`	`officeQuery`	the office query
Parameters	`osid.workflow.OfficeSearch`	`officeSearch`	the office search
Return	`osid.workflow.OfficeSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`officeQuery` or `officeSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`officeQuery` or `officeSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOfficeQueryFromInspector
Description	Gets an office query from an inspector. The inspector is available from an `OfficeSearchResults.`
Parameters	`osid.workflow.OfficeQueryInspector`	`officeQueryInspector`	an office query inspector
Return	`osid.workflow.OfficeQuery`		the office query
Errors	NULL_ARGUMENT		`officeQueryInspector` is `null`
Errors	UNSUPPORTED		`officeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.