OSID - osid.forum.ReplyQuery Service Interface Definition

Interface	osid.forum.ReplyQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidContainableQuery`
	`osid.OsidSubjugateableQuery`
Description	This is the query for searching for replies. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchPostId
Description	Sets the post `Id` for this query to match replies to posts.
Parameters	`osid.id.Id`	`postId`	a post `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`postId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPostIdTerms
Description	Clears the post `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostQuery
Description	Tests if a `PostQuery` is available.
Return	`boolean`		`true` if a post query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPostQuery
Description	Gets the query for a post query. Multiple retrievals produce a nested `OR` term.
Return	`osid.forum.PostQuery`		the post query
Errors	UNIMPLEMENTED		`supportsPostQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostQuery()` is `true.`
Method	clearPostTerms
Description	Clears the post terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimestamp
Description	Matches entries whose sent time is between the supplied range inclusive.
Parameters	`osid.calendaring.DateTime`	`startTime`	start time
	`osid.calendaring.DateTime`	`endTime`	end time
	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`startTime` is greater than `endTime`
Errors	NULL_ARGUMENT		`startTime` or `endTime` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimestampTerms
Description	Clears the timestamp terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPosterId
Description	Matches the poster of the entry.
Parameters	`osid.id.Id`	`resourceId`	resource `Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPosterIdTerms
Description	Clears the poster resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPosterQuery
Description	Tests if a `ResourceQuery` is available for querying posters.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPosterQuery
Description	Gets the query for a resource.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsPosterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPosterQuery()` is `true.`
Method	clearPosterTerms
Description	Clears the poster terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPostingAgentId
Description	Matches the posting agent of the entry.
Parameters	`osid.id.Id`	`agentId`	agent `Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPostingAgentIdTerms
Description	Clears the posting agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostingAgentQuery
Description	Tests if an `AgentQuery` is available for querying posting agents.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPostingAgentQuery
Description	Gets the query for an agent.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsPostingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostingAgentQuery()` is `true.`
Method	clearPostingAgentTerms
Description	Clears the posting agent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSubjectLine
Description	Adds a subject line to match. Multiple subject line matches can be added to perform a boolean `OR` among them.
Parameters	`string`	`subject`	display name to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`subject is` not of `stringMatchType`
	NULL_ARGUMENT		`subject` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySubjectLine
Description	Matches entries with any subject line.
Parameters	`boolean`	`match`	`true` to match entries with any subject line, `false` to match entries with no subject line
Compliance	`mandatory`		This method must be implemented.
Method	clearSubjectLineTerms
Description	Clears the subject line terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchText
Description	Adds text to match. Multiple text matches can be added to perform a boolean `OR` among them.
Parameters	`string`	`text`	text to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`text is` not of `stringMatchType`
	NULL_ARGUMENT		`text` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyText
Description	Matches entries with any text.
Parameters	`boolean`	`match`	`true` to match entries with any text, `false` to match entries with no text
Compliance	`mandatory`		This method must be implemented.
Method	clearTextTerms
Description	Clears the text terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContainingReplyId
Description	Sets the reply `Id` for this query to match replies that have the specified reply as an ancestor.
Parameters	`osid.id.Id`	`replyId`	a reply `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`replyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearContainingReplyIdTerms
Description	Clears the containing reply `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsContainingReplyQuery
Description	Tests if a containing reply query is available.
Return	`boolean`		`true` if a containing reply query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getContainingReplyQuery
Description	Gets the query for a containing reply.
Return	`osid.forum.ReplyQuery`		the containing reply query
Errors	UNIMPLEMENTED		`supportsContainingReplyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContainingReplyQuery()` is `true.`
Method	matchAnyContainingReply
Description	Matches replies with any ancestor reply.
Parameters	`boolean`	`match`	`true` to match replies with any ancestor reply, `false` to match replies with no ancestor replies
Compliance	`mandatory`		This method must be implemented.
Method	clearContainingReplyTerms
Description	Clears the containing reply terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContainedReplyId
Description	Sets the reply `Id` for this query to match replies that have the specified reply as a descendant.
Parameters	`osid.id.Id`	`replyId`	a reply `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`replyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearContainedReplyIdTerms
Description	Clears the contained reply `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsContainedReplyQuery
Description	Tests if a contained reply query is available.
Return	`boolean`		`true` if a contained reply query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getContainedReplyQuery
Description	Gets the query for a contained reply.
Return	`osid.forum.ReplyQuery`		the contained reply query
Errors	UNIMPLEMENTED		`supportsContainedReplyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsContainedReplyQuery()` is `true.`
Method	matchAnyContainedReply
Description	Matches replies with any descednant reply.
Parameters	`boolean`	`match`	`true` to match replies with any descendant reply, `false` to match replies with no descendant replies
Compliance	`mandatory`		This method must be implemented.
Method	clearContainedReplyTerms
Description	Clears the contained reply terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchForumId
Description	Sets the post `Id` for this query to match replies assigned to forums.
Parameters	`osid.id.Id`	`forumId`	a forum `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`forumId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearForumIdTerms
Description	Clears the forum `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsForumQuery
Description	Tests if a `ForumQuery` is available.
Return	`boolean`		`true` if a forum query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getForumQuery
Description	Gets the query for a forum query. Multiple retrievals produce a nested `OR` term.
Return	`osid.forum.ForumQuery`		the forum query
Errors	UNIMPLEMENTED		`supportsForumQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsForumQuery()` is `true.`
Method	clearForumTerms
Description	Clears the forum terms.
Compliance	`mandatory`		This method must be implemented.
Method	getReplyQueryRecord
Description	Gets the reply query record corresponding to the given `Reply` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`replyRecordType`	a reply record type
Return	`osid.forum.records.ReplyQueryRecord`		the reply query 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.