OSID - osid.hold.BlockQuery Service Interface Definition

Interface	osid.hold.BlockQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching blocks. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchIssueId
Description	Sets the issue `Id` for this query.
Parameters	`osid.id.Id`	`issueId`	the issue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`issueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIssueIdTerms
Description	Clears the issue `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueQuery
Description	Tests if an `IssueQuery` is available.
Return	`boolean`		`true` if an issue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueQuery
Description	Gets the query for an issue. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.IssueQuery`		the issue query
Errors	UNIMPLEMENTED		`supportsIssueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsIssueQuery()` is `true.`
Method	matchAnyIssue
Description	Matches blocks that have any issue.
Parameters	`boolean`	`match`	`true` to match blocks with any issue, `false` to match blocks with no issue
Compliance	`mandatory`		This method must be implemented.
Method	clearIssueTerms
Description	Clears the issue query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOublietteId
Description	Sets the oubliette `Id` for this query to match blocks 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 a `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	getBlockQueryRecord
Description	Gets the block query record corresponding to the given `Block` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`blockRecordType`	a block record type
Return	`osid.hold.records.BlockQueryRecord`		the block query record
Errors	NULL_ARGUMENT		`blockRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(blockRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.