OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CredentialEntrySearchSession
Implementsosid.course.chronicle.CredentialEntryQuerySession
Description

This session provides methods for searching among CredentialEntries. The search query is constructed using the CredentialEntryQuery.

getCredentialEntriesByQuery() is the basic search method and returns a list of CredentialEntries. A more advanced search may be performed with getCredentialEntriesBySearch(). It accepts a CredentialEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCredentialEntriesBySearch() returns a CredentialEntrySearchResults that can be used to access the resulting CredentialEntryList or be used to perform a search within the result set through CredentialEntrySearch.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include credential 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

CredentialEntries may have a query record indicated by their respective record types. The query record is accessed via the CredentialEntryQuery.

MethodgetCredentialEntrySearch
Description

Gets a credential entry search.

Returnosid.course.chronicle.CredentialEntrySearchthe credential entry search
CompliancemandatoryThis method must be implemented.
MethodgetCredentialEntrySearchOrder
Description

Gets a credential entry search order. The CredentialEntrySearchOrder is supplied to a CredentialEntrySearch to specify the ordering of results.

Returnosid.course.chronicle.CredentialEntrySearchOrderthe credential entry search order
CompliancemandatoryThis method must be implemented.
MethodgetCredentialEntriesBySearch
Description

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

Parametersosid.course.chronicle.CredentialEntryQuerycredentialEntryQuerythe credential entry query
osid.course.chronicle.CredentialEntrySearchcredentialEntrySearchthe credential entry search
Returnosid.course.chronicle.CredentialEntrySearchResultsthe credential entry search results
ErrorsNULL_ARGUMENT credentialEntryQuery or credentialEntrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED credentialEntryQuery or CredentialEntrySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCredentialEntryQueryFromInspector
Description

Gets a credential entry query from an inspector. The inspector is available from a CredentialEntrySearchResults.

Parametersosid.course.chronicle.CredentialEntryQueryInspectorcredentialEntryQueryInspectora credential entry query inspector
Returnosid.course.chronicle.CredentialEntryQuerythe credential entry query
ErrorsNULL_ARGUMENT credentialEntryQueryInspector is null
UNSUPPORTED credentialEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.