OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CredentialSearchSession
Implementsosid.course.program.CredentialQuerySession
Description

This session provides methods for searching among credential objects. The search query is constructed using the CredentialQuery.

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

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include credentials in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to credentials in this course catalog

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

MethodgetCredentialSearch
Description

Gets a credential search.

Returnosid.course.program.CredentialSearchthe credential search
CompliancemandatoryThis method must be implemented.
MethodgetCredentialSearchOrder
Description

Gets a credential search order. The CredentialSearchOrder is supplied to a CredentialSearch to specify the ordering of results.

Returnosid.course.program.CredentialSearchOrderthe credential search order
CompliancemandatoryThis method must be implemented.
MethodgetCredentialsBySearch
Description

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

Parametersosid.course.program.CredentialQuerycredentialQuerythe credential query
osid.course.program.CredentialSearchcredentialSearchthe credential search
Returnosid.course.program.CredentialSearchResultsthe credential search results
ErrorsNULL_ARGUMENT credentialQuery or credentialSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED credentialQuery or credentialSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCredentialQueryFromInspector
Description

Gets a credential query from an inspector. The inspector is available from a CredentialSearchResults.

Parametersosid.course.program.CredentialQueryInspectorcredentialQueryInspectora credential query inspector
Returnosid.course.program.CredentialQuerythe credential query
ErrorsNULL_ARGUMENT credentialQueryInspector is null
UNSUPPORTED credentialQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.