OSID Logo
OSID Specifications
forum package
Version 3.0.0
Release Candidate Preview
Interfaceosid.forum.ReplySearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidContainableSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByTimestamp
Description

Specifies a preference for ordering the result set by the timestamp.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByPoster
Description

Specifies a preference for ordering the result set by the poster.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsPosterSearchOrder
Description

Tests if a poster resource search order interface is available.

Returnboolean true if a resource search order interface is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPosterSearchOrder
Description

Gets the resource search order interface.

Returnosid.resource.ResourceSearchOrderthe resource search order interface
ErrorsUNIMPLEMENTED supportsPosterSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsPosterSearchOrder() is true.
MethodorderByPostingAgent
Description

Specifies a preference for ordering the result set by the posting agent.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsPostingAgentSearchOrder
Description

Tests if a posting agent search order interface is available.

Returnboolean true if a agent search order interface is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPostingAgentSearchOrder
Description

Gets the posting agent search order interface.

Returnosid.authentication.AgentSearchOrderthe agent search order interface
ErrorsUNIMPLEMENTED supportsPostingAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsPostingAgentSearchOrder() is true.
MethodorderBySubjectLine
Description

Specifies a preference for ordering the result set by the subject.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByText
Description

Specifies a preference for ordering the result set by the text.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetReplySearchOrderRecord
Description

Gets the reply search order record corresponding to the given reply record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypereplyRecordTypea reply record type
Returnosid.forum.records.ReplySearchOrderRecordthe reply search order record
ErrorsNULL_ARGUMENT replyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(replyRecordType) is false
CompliancemandatoryThis method must be implemented.