Interface | osid.course.chronicle.CredentialEntrySearchSession | ||
---|---|---|---|
Implements | osid.course.chronicle.CredentialEntryQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
CredentialEntries may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
Method | getCredentialEntrySearch | ||
Description |
Gets a credential entry search. | ||
Return | osid.course.chronicle.CredentialEntrySearch | the credential entry search | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialEntrySearchOrder | ||
Description |
Gets a credential entry search order. The | ||
Return | osid.course.chronicle.CredentialEntrySearchOrder | the credential entry search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialEntriesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.course.chronicle.CredentialEntryQuery | credentialEntryQuery | the credential entry query |
osid.course.chronicle.CredentialEntrySearch | credentialEntrySearch | the credential entry search | |
Return | osid.course.chronicle.CredentialEntrySearchResults | the credential entry search results | |
Errors | NULL_ARGUMENT | credentialEntryQuery or credentialEntrySearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | credentialEntryQuery or CredentialEntrySearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialEntryQueryFromInspector | ||
Description |
Gets a credential entry query from an inspector. The
inspector is available from a | ||
Parameters | osid.course.chronicle.CredentialEntryQueryInspector | credentialEntryQueryInspector | a credential entry query inspector |
Return | osid.course.chronicle.CredentialEntryQuery | the credential entry query | |
Errors | NULL_ARGUMENT | credentialEntryQueryInspector is null | |
UNSUPPORTED | credentialEntryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |