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

Interface	osid.course.chronicle.AssessmentEntrySearchSession
Implements	`osid.course.chronicle.AssessmentEntryQuerySession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session provides methods for searching among `AssessmentEntries` . The search query is constructed using the `AssessmentEntryQuery` . `getAssessmentEntriesByQuery()` is the basic search method and returns a list of `AssessmentEntries` . A more advanced search may be performed with `getAssessmentEntriesBySearch()` . It accepts an `AssessmentEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAssessmentEntriesBySearch()` returns an `AssessmentEntrySearchResults` that can be used to access the resulting `AssessmentEntryList` or be used to perform a search within the result set through `AssessmentEntrySearch` . This session defines views that offer differing behaviors for searching. federated course catalog view: searches include assessment 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 AssessmentEntries may have a query record indicated by their respective record types. The query record is accessed via the `AssessmentEntryQuery` .
Method	getAssessmentEntrySearch
Description	Gets an assessment entry search.
Return	`osid.course.chronicle.AssessmentEntrySearch`		the assessment entry search
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentEntrySearchOrder
Description	Gets an assessment entry search order. The `AssessmentEntrySearchOrder` is supplied to an `AssessmentEntrySearch` to specify the ordering of results.
Return	`osid.course.chronicle.AssessmentEntrySearchOrder`		the assessment entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentEntriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.course.chronicle.AssessmentEntryQuery`	`assessmentEntryQuery`	the assessment entry query
Parameters	`osid.course.chronicle.AssessmentEntrySearch`	`assessmentEntrySearch`	the assessment entry search
Return	`osid.course.chronicle.AssessmentEntrySearchResults`		the assessment entry search results
Errors	NULL_ARGUMENT		`assessmentEntryQuery` or `assessmentEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`assessmentEntryQuery` or `AssessmentEntrySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentEntryQueryFromInspector
Description	Gets an assessment entry query from an inspector. The inspector is available from an `AssessmentEntrySearchResults` .
Parameters	`osid.course.chronicle.AssessmentEntryQueryInspector`	`assessmentEntryQueryInspector`	an assessment entry query inspector
Return	`osid.course.chronicle.AssessmentEntryQuery`		the assessment entry query
Errors	NULL_ARGUMENT		`assessmentEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`assessmentEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.