OSID - osid.mapping.path.PathSearchResults Service Interface Definition

Interface	osid.mapping.path.PathSearchResults
Implements	`osid.OsidSearchResults`
Description	This interface provides a means to capture results of a search.
Method	getPaths
Description	Gets the path list resulting from a search.
Return	`osid.mapping.path.PathList`		the path list
Errors	ILLEGAL_STATE		list already retrieved
Compliance	`mandatory`		This method must be implemented.
Method	getPathQueryInspector
Description	Gets the inspector for the query to examine the terms used in the search.
Return	`osid.mapping.path.PathQueryInspector`		the path query inspector
Compliance	`mandatory`		This method must be implemented.
Method	getPathSearchResultsRecord
Description	Gets the path search results record corresponding to the given path search record `Type.` This method is used to retrieve an object implementing the requested record.
Parameters	`osid.type.Type`	`pathSearchRecordType`	a path search record type
Return	`osid.mapping.path.records.PathSearchResultsRecord`		the path search results record
Errors	NULL_ARGUMENT		`pathSearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(pathSearchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.