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

Interface	osid.mapping.path.PathSearch
Implements	`osid.OsidSearch`
Used By	`osid.mapping.path.PathSearchSession`
Description	The search interface for governing path searches.
Method	searchAmongPaths
Description	Execute this search among the given list of paths.
Parameters	`osid.id.IdList`	`pathIds`	list of paths
Errors	NULL_ARGUMENT		`pathIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderPathResults
Description	Specify an ordering to the search results.
Parameters	`osid.mapping.path.PathSearchOrder`	`pathSearchOrder`	path search order
Errors	NULL_ARGUMENT		`pathSearchOrder` is `null`
Errors	UNSUPPORTED		`pathSearchOrder` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPathSearchRecord
Description	Gets the path search 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.PathSearchRecord`		the path search 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.