Interface | osid.course.chronicle.CredentialEntrySearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByStudent | ||
Description |
Specifies a preference for ordering the result set by the resource. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsStudentSearchOrder | ||
Description |
Tests if a resource order is available. | ||
Return | boolean | true if a resource order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStudentSearchOrder | ||
Description |
Gets the resource order. | ||
Return | osid.resource.ResourceSearchOrder | the resource search order | |
Errors | UNIMPLEMENTED | supportsStudentSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsStudentSearchOrder()
is true. | |
Method | orderByCredential | ||
Description |
Specifies a preference for ordering the result set by the credential. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCredentialSearchOrder | ||
Description |
Tests if a credential order is available. | ||
Return | boolean | true if a credential order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialSearchOrder | ||
Description |
Gets the credential order. | ||
Return | osid.course.program.CredentialSearchOrder | the credential search order | |
Errors | UNIMPLEMENTED | supportsCredentialSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsCredentialSearchOrder()
is true. | |
Method | orderByDateAwarded | ||
Description |
Specifies a preference for ordering the result set by the award date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByProgram | ||
Description |
Specifies a preference for ordering the result set by the program. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProgramSearchOrder | ||
Description |
Tests if a program order is available. | ||
Return | boolean | true if a program order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramSearchOrder | ||
Description |
Gets the program order. | ||
Return | osid.course.program.ProgramSearchOrder | the program search order | |
Errors | UNIMPLEMENTED | supportsProgramSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsProgramSearchOrder()
is true. | |
Method | getCredentialEntrySearchOrderRecord | ||
Description |
Gets the chronicle search order record corresponding to
the given credential entry record | ||
Parameters | osid.type.Type | credentialEntryRecordType | a credential entry record type |
Return | osid.course.chronicle.records.CredentialEntrySearchOrderRecord | the credential entry search order record | |
Errors | NULL_ARGUMENT | credentialEntryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(credentialEntryRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |