Interface | osid.forum.ReplySearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidContainableSearchOrder | |||
osid.OsidSubjugateableSearchOrder | |||
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 poster resource search order interface is available. | ||
Return | boolean | true if a resource search order interface is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPosterSearchOrder | ||
Description |
Gets the resource search order interface. | ||
Return | osid.resource.ResourceSearchOrder | the resource 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 search order interface is available. | ||
Return | boolean | true if a agent search 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 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 | getReplySearchOrderRecord | ||
Description |
Gets the reply search order record corresponding to the
given reply record | ||
Parameters | osid.type.Type | replyRecordType | a reply record type |
Return | osid.forum.records.ReplySearchOrderRecord | the reply search order record | |
Errors | NULL_ARGUMENT | replyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(replyRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |