OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AssessmentEntrySearchSession
Implementsosid.course.chronicle.AssessmentEntryQuerySession
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.

MethodgetAssessmentEntrySearch
Description

Gets an assessment entry search.

Returnosid.course.chronicle.AssessmentEntrySearchthe assessment entry search
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntrySearchOrder
Description

Gets an assessment entry search order. The AssessmentEntrySearchOrder is supplied to an AssessmentEntrySearch to specify the ordering of results.

Returnosid.course.chronicle.AssessmentEntrySearchOrderthe assessment entry search order
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntriesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.course.chronicle.AssessmentEntryQueryassessmentEntryQuerythe assessment entry query
osid.course.chronicle.AssessmentEntrySearchassessmentEntrySearchthe assessment entry search
Returnosid.course.chronicle.AssessmentEntrySearchResultsthe assessment entry search results
ErrorsNULL_ARGUMENT assessmentEntryQuery or assessmentEntrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED assessmentEntryQuery or AssessmentEntrySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentEntryQueryFromInspector
Description

Gets an assessment entry query from an inspector. The inspector is available from an AssessmentEntrySearchResults.

Parametersosid.course.chronicle.AssessmentEntryQueryInspectorassessmentEntryQueryInspectoran assessment entry query inspector
Returnosid.course.chronicle.AssessmentEntryQuerythe assessment entry query
ErrorsNULL_ARGUMENT assessmentEntryQueryInspector is null
UNSUPPORTED assessmentEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.