Interface | osid.course.program.CredentialSearchSession | ||
---|---|---|---|
Implements | osid.course.program.CredentialQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Credentials may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getCredentialSearch | ||
Description |
Gets a credential search. | ||
Return | osid.course.program.CredentialSearch | the credential search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialSearchOrder | ||
Description |
Gets a credential search order. The | ||
Return | osid.course.program.CredentialSearchOrder | the credential search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.course.program.CredentialQuery | credentialQuery | the credential query |
osid.course.program.CredentialSearch | credentialSearch | the credential search | |
Return | osid.course.program.CredentialSearchResults | the credential search results | |
Errors | NULL_ARGUMENT | credentialQuery or credentialSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | credentialQuery or credentialSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialQueryFromInspector | ||
Description |
Gets a credential query from an inspector. The
inspector is available from a | ||
Parameters | osid.course.program.CredentialQueryInspector | credentialQueryInspector | a credential query inspector |
Return | osid.course.program.CredentialQuery | the credential query | |
Errors | NULL_ARGUMENT | credentialQueryInspector is null | |
UNSUPPORTED | credentialQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |