OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.CommentSearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByReference
Description

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

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

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

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

Tests if a resource order interface is available.

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

Gets the resource order interface.

Returnosid.resource.ResourceQuerythe resource search order interface
ErrorsUNIMPLEMENTED supportsCommentorSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCommentorSearchOrder() is true.
MethodorderByCommentingAgent
Description

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

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

Tests if an agent order interface is available.

Returnboolean true if an agent order interface is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCommentingAgentSearchOrder
Description

Gets the agent order interface.

Returnosid.authentication.AgentSearchOrderthe agent search order interface
ErrorsUNIMPLEMENTED supportsCommentingAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCommentingAgentSearchOrder() is true.
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.
MethodorderByRating
Description

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

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

Tests if a rating order interface is available.

Returnboolean true if a rating order interface is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRatingSearchOrder
Description

Gets the rating order interface.

Returnosid.grading.GradeSearchOrderthe rating search order interface
ErrorsUNIMPLEMENTED supportsRatingSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsRatingSearchOrder() is true.
MethodgetCommentSearchOrderRecord
Description

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

Parametersosid.type.TypecommentRecordTypea comment record type
Returnosid.commenting.records.CommentSearchOrderRecordthe comment search order record
ErrorsNULL_ARGUMENT commentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commentRecordType) is false
CompliancemandatoryThis method must be implemented.