OSID - osid.commenting.CommentSearchOrder Service Interface Definition

Interface	osid.commenting.CommentSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.commenting.CommentSearchSession`
Used By	`osid.commenting.CommentSmartBookSession`
Description	An interface for specifying the ordering of search results.
Method	orderByReference
Description	Specifies a preference for ordering the result set by the reference.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCommentor
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	supportsCommentorSearchOrder
Description	Tests if a resource order interface is available.
Return	`boolean`		`true` if a resource order interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommentorSearchOrder
Description	Gets the resource order interface.
Return	`osid.resource.ResourceQuery`		the resource search order interface
Errors	UNIMPLEMENTED		`supportsCommentorSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentorSearchOrder()` is `true`.
Method	orderByCommentingAgent
Description	Specifies a preference for ordering the result set by the agent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentingAgentSearchOrder
Description	Tests if an agent order interface is available.
Return	`boolean`		`true` if an agent order interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommentingAgentSearchOrder
Description	Gets the agent order interface.
Return	`osid.authentication.AgentSearchOrder`		the agent search order interface
Errors	UNIMPLEMENTED		`supportsCommentingAgentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommentingAgentSearchOrder()` is `true`.
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	orderByRating
Description	Specifies a preference for ordering the result set by the rating.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRatingSearchOrder
Description	Tests if a rating order interface is available.
Return	`boolean`		`true` if a rating order interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRatingSearchOrder
Description	Gets the rating order interface.
Return	`osid.grading.GradeSearchOrder`		the rating search order interface
Errors	UNIMPLEMENTED		`supportsRatingSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRatingSearchOrder()` is `true`.
Method	getCommentSearchOrderRecord
Description	Gets the comment search order record corresponding to the given comment record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`commentRecordType`	a comment record type
Return	`osid.commenting.records.CommentSearchOrderRecord`		the comment search order record
Errors	NULL_ARGUMENT		`commentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(commentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.