OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
acknowledgement package
Version 3.0.0
Release Candidate Preview
| Interface | osid.acknowledgement.CreditSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing credit searches. | ||
| Method | searchAmongCredits | ||
| Description |
Execute this search among the given list of credits. | ||
| Parameters | osid.id.IdList | creditIds | list of credits |
| Errors | NULL_ARGUMENT | creditIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderCreditResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.acknowledgement.CreditSearchOrder | creditSearchOrder | credit search order |
| Errors | NULL_ARGUMENT | creditSearchOrder is null | |
| UNSUPPORTED | creditSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditSearchRecord | ||
| Description |
Gets the record corresponding to the given credit
search record | ||
| Parameters | osid.type.Type | creditSearchRecordType | a credit search record type |
| Return | osid.acknowledgement.records.CreditSearchRecord | the credit search record | |
| Errors | NULL_ARGUMENT | creditSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(creditSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |