OSID - osid.room.construction.ProjectSearchSession Service Interface Definition

Interface	osid.room.construction.ProjectSearchSession
Implements	`osid.room.construction.ProjectQuerySession`
Used By	`osid.room.construction.RoomConstructionManager`
Used By	`osid.room.construction.RoomConstructionProxyManager`
Description	This session provides methods for searching `Projects` . The search query is constructed using the `ProjectQuery` . The project record `Type` also specifies the record for the project query. `getProjectsByQuery()` is the basic search method and returns a list of `Project` elements. A more advanced search may be performed with `getProjectsBySearch()` .It accepts a `ProjectSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProjectsBySearch()` returns a `ProjectSearchResults` that can be used to access the resulting `ProjectList` or be used to perform a search within the result set through `ProjectSearch` . Projects may have a query record indicated by their respective record types. The query record is accessed via the `ProjectQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getProjectSearch
Description	Gets a project search.
Return	`osid.room.construction.ProjectSearch`		the project search
Compliance	`mandatory`		This method must be implemented.
Method	getProjectSearchOrder
Description	Gets a project search order. The `ProjectSearchOrder` is supplied to a `ProjectSearch` to specify the ordering of results.
Return	`osid.room.construction.ProjectSearchOrder`		the project search order
Compliance	`mandatory`		This method must be implemented.
Method	getProjectsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.room.construction.ProjectQuery`	`projectQuery`	the project query
Parameters	`osid.room.construction.ProjectSearch`	`projectSearch`	the project search
Return	`osid.room.construction.ProjectSearchResults`		the project search results
Errors	NULL_ARGUMENT		`projectQuery` or `projectSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`projectQuery` or `projectSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProjectQueryFromInspector
Description	Gets a project query from an inspector. The inspector is available from a `ProjectSearchResults` .
Parameters	`osid.room.construction.ProjectQueryInspector`	`projectQueryInspector`	a query inspector
Return	`osid.room.construction.ProjectQuery`		the project query
Errors	NULL_ARGUMENT		`projectQueryInspector` is `null`
Errors	UNSUPPORTED		`projectQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.