OSID - osid.course.chronicle.AwardEntrySearchSession Service Interface Definition

Interface	osid.course.chronicle.AwardEntrySearchSession
Implements	`osid.course.chronicle.AwardEntryQuerySession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session provides methods for searching among `AwardEntries` . The search query is constructed using the `AwardEntryQuery` . `getAwardEntriesByQuery()` is the basic search method and returns a list of `AwardEntries` . A more advanced search may be performed with `getAwardEntriesBySearch()` .It accepts an `AwardEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAwardEntriesBySearch()` returns an `AwardEntrySearchResults` that can be used to access the resulting `AwardEntryList` or be used to perform a search within the result set through `AwardEntrySearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include award entries in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy isolated course catalog view: searches are restricted to courses in this course catalog AwardEntries may have a query record indicated by their respective record types. The query record is accessed via the `AwardEntryQuery` .
Method	getAwardEntrySearch
Description	Gets an award entry search.
Return	`osid.course.chronicle.AwardEntrySearch`		the award entry search
Compliance	`mandatory`		This method must be implemented.
Method	getAwardEntrySearchOrder
Description	Gets an award entry search order. The `AwardEntrySearchOrder` is supplied to an `AwardEntrySearch` to specify the ordering of results.
Return	`osid.course.chronicle.AwardEntrySearchOrder`		the award entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getAwardEntriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.chronicle.AwardEntryQuery`	`awardEntryQuery`	the award entry query
Parameters	`osid.course.chronicle.AwardEntrySearch`	`awardEntrySearch`	the award entry search
Return	`osid.course.chronicle.AwardEntrySearchResults`		the award entry search results
Errors	NULL_ARGUMENT		`awardEntryQuery` or `awardEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`awardEntryQuery` or `AwardEntrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAwardEntryQueryFromInspector
Description	Gets an award entry query from an inspector. The inspector is available from an `AwardEntrySearchResults` .
Parameters	`osid.course.chronicle.AwardEntryQueryInspector`	`awardEntryQueryInspector`	an award entry query inspector
Return	`osid.course.chronicle.AwardEntryQuery`		the award entry query
Errors	NULL_ARGUMENT		`awardEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`awardEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.