OSID - osid.hold.OublietteQuery Service Interface Definition

Interface	osid.hold.OublietteQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching oubliettes. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchBlockId
Description	Sets the effort `Id` for this query to match oubliettes containing blocks.
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 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 oubliettes that have any block.
Parameters	`boolean`	`match`	`true` to match oubliettes with any block, `false` to match oubliettes with no block
Compliance	`mandatory`		This method must be implemented.
Method	clearBlockTerms
Description	Clears the block query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIssueId
Description	Sets the issue `Id` for this query to match oubliettes that have a related issue.
Parameters	`osid.id.Id`	`issueId`	a issue `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for 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 a `IssueQuery` is available.
Return	`boolean`		`true` if a issue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueQuery
Description	Gets the query for a 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 oubliettes that have any issue.
Parameters	`boolean`	`match`	`true` to match oubliettes with any issue, `false` to match oubliettes 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	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 oubliettes referenced by any hold.
Parameters	`boolean`	`match`	`true` to match oubliettes with any holds, `false` to match oubliettes 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	matchAncestorOublietteId
Description	Sets the oubliette `Id` for this query to match oubliettes that have the specified oubliette as an ancestor.
Parameters	`osid.id.Id`	`oublietteId`	an oubliette `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`oublietteId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorOublietteIdTerms
Description	Clears the ancestor oubliette `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorOublietteQuery
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	getAncestorOublietteQuery
Description	Gets the query for an oubliette. Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.OublietteQuery`		the oubliette query
Errors	UNIMPLEMENTED		`supportsAncestorOublietteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorOublietteQuery()` is `true.`
Method	matchAnyAncestorOubliette
Description	Matches oubliettes with any ancestor.
Parameters	`boolean`	`match`	`true` to match oubliettes with any ancestor, `false` to match root oubliettes
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorOublietteTerms
Description	Clears the ancestor oubliette query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantOublietteId
Description	Sets the oubliette `Id` for this query to match oubliettes that have the specified oubliette as a descendant.
Parameters	`osid.id.Id`	`oublietteId`	an oubliette `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`oublietteId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantOublietteIdTerms
Description	Clears the descendant oubliette `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantOublietteQuery
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	getDescendantOublietteQuery
Description	Gets the query for an oubliette/ Multiple retrievals produce a nested `OR` term.
Return	`osid.hold.OublietteQuery`		the oubliette query
Errors	UNIMPLEMENTED		`supportsDescendantOublietteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantOublietteQuery()` is `true.`
Method	matchAnyDescendantOubliette
Description	Matches oubliettes with any descendant.
Parameters	`boolean`	`match`	`true` to match oubliettes with any descendant, `false` to match leaf oubliettes
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantOublietteTerms
Description	Clears the descendant oubliette query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteQueryRecord
Description	Gets the oubliette query record corresponding to the given `Oubliette` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`oublietteRecordType`	an oubliette record type
Return	`osid.hold.records.OublietteQueryRecord`		the oubliette query record
Errors	NULL_ARGUMENT		`oublietteRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(oublietteRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.