OSID - osid.hold.IssueQuery Service Interface Definition

Interface	osid.hold.IssueQuery
Implements	`osid.OsidGovernatorQuery`
Used By	`osid.hold.BlockQuery`
	`osid.hold.HoldQuery`
	`osid.hold.IssueQuerySession`
	`osid.hold.IssueSearchSession`
	`osid.hold.IssueSmartOublietteSession`
	`osid.hold.OublietteQuery`
	`osid.hold.rules.IssueConstrainerQuery`
	`osid.hold.rules.IssueEnablerQuery`
	`osid.hold.rules.IssueProcessorQuery`
Description	This is the query for searching issues. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchBureauId
Description	Sets the bureau `Id` for this query.
Parameters	`osid.id.Id`	`bureauId`	the bureau `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`bureauId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBureauIdTerms
Description	Clears the bureau `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBureauQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBureauQuery
Description	Gets the query for a bureau. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the bureau query
Errors	UNIMPLEMENTED		`supportsBureauQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBureauQuery()` is `true`.
Method	matchAnyBureau
Description	Matches issues with any bureau.
Parameters	`boolean`	`match`	`true` to match issues with any bureaus, `false` to match issues with no bureaus
Compliance	`mandatory`		This method must be implemented.
Method	clearBureauTerms
Description	Clears the bureau query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBlockId
Description	Sets the block `Id` for this query.
Parameters	`osid.id.Id`	`blockId`	the block `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`blockId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBlockIdTerms
Description	Clears the block `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockQuery
Description	Tests if a `BlockQuery` is available.
Return	`boolean`		`true` if a block query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBlockQuery
Description	Gets the query for a block. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.BlockQuery`		the block query
Errors	UNIMPLEMENTED		`supportsBlockQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBlockQuery()` is `true`.
Method	matchAnyBlock
Description	Matches issues used for any block.
Parameters	`boolean`	`match`	`true` to match issues with any blocks, `false` to match issues with no blocks
Compliance	`mandatory`		This method must be implemented.
Method	clearBlockTerms
Description	Clears the block query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHoldId
Description	Sets the hold `Id` for this query.
Parameters	`osid.id.Id`	`holdId`	the hold `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`holdId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearHoldIdTerms
Description	Clears the hold `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsHoldQuery
Description	Tests if a `HoldQuery` is available.
Return	`boolean`		`true` if a hold query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getHoldQuery
Description	Gets the query for a hold. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.HoldQuery`		the hold query
Errors	UNIMPLEMENTED		`supportsHoldQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsHoldQuery()` is `true`.
Method	matchAnyHold
Description	Matches issues referenced by any hold.
Parameters	`boolean`	`match`	`true` to match issues with any holds, `false` to match issues with no holds
Compliance	`mandatory`		This method must be implemented.
Method	clearHoldTerms
Description	Clears the hold query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOublietteId
Description	Sets the oubliette `Id` for this query to match issues assigned to foundries.
Parameters	`osid.id.Id`	`oublietteId`	the oubliette `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`oublietteId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOublietteIdTerms
Description	Clears the oubliette `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOublietteQuery
Description	Tests if an `OublietteQuery` is available.
Return	`boolean`		`true` if an oubliette query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteQuery
Description	Gets the query for an oubliette. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.OublietteQuery`		the oubliette query
Errors	UNIMPLEMENTED		`supportsOublietteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOublietteQuery()` is `true`.
Method	clearOublietteTerms
Description	Clears the oubliette query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getIssueQueryRecord
Description	Gets the issue query record corresponding to the given `Issue` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`issueRecordType`	an issue record type
Return	`osid.hold.records.IssueQueryRecord`		the issue query record
Errors	NULL_ARGUMENT		`issueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(issueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.