OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
forum package
Version 3.0.0
Release Candidate Preview
| Interface | osid.forum.PostSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByTimestamp | ||
| Description |
Specifies a preference for ordering the result set by the timestamp. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPoster | ||
| Description |
Specifies a preference for ordering the result set by the poster. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPosterSearchOrder | ||
| Description |
Tests if a resource order interface is available. | ||
| Return | boolean | true if a poster order interface is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPosterSearchOrder | ||
| Description |
Gets the poster order interface. | ||
| Return | osid.resource.ResourceSearchOrder | the poster search order interface | |
| Errors | UNIMPLEMENTED | supportsPosterSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsPosterSearchOrder()
is true. | |
| Method | orderByPostingAgent | ||
| Description |
Specifies a preference for ordering the result set by the posting agent. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPostingAgentSearchOrder | ||
| Description |
Tests if a posting agent order interface is available. | ||
| Return | boolean | true if a posting agent order interface is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostingAgentSearchOrder | ||
| Description |
Gets the posting agent search order interface. | ||
| Return | osid.authentication.AgentSearchOrder | the posting agent search order interface | |
| Errors | UNIMPLEMENTED | supportsPostingAgentSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsPostingAgentSearchOrder()
is true. | |
| Method | orderBySubjectLine | ||
| Description |
Specifies a preference for ordering the result set by the subject. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByText | ||
| Description |
Specifies a preference for ordering the result set by the text. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostSearchOrderRecord | ||
| Description |
Gets the post search record order corresponding to the given post record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | postRecordType | a post record type |
| Return | osid.forum.records.PostSearchOrderRecord | the post search order record | |
| Errors | NULL_ARGUMENT | postRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(postRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |