OSID - osid.resource.BinQuery Service Interface Definition

Interface	osid.resource.BinQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching bins. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchResourceId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
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	getResourceQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true.`
Method	matchAnyResource
Description	Matches bins with any resource.
Parameters	`boolean`	`match`	`true` to match bins with any resource, `false` to match bins with no resources
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorBinId
Description	Sets the bin `Id` for this query to match bins that have the specified bin as an ancestor.
Parameters	`osid.id.Id`	`binid`	a bin `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`binId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBinIdTerms
Description	Clears the ancestor bin `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorBinQuery
Description	Tests if a `BinQuery` is available.
Return	`boolean`		`true` if a bin query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorBinQuery
Description	Gets the query for a bin. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.BinQuery`		the bin query
Errors	UNIMPLEMENTED		`supportsAncestorBinQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorBinQuery()` is `true.`
Method	matchAnyAncestorBin
Description	Matches bins with any ancestor.
Parameters	`boolean`	`match`	`true` to match bins with any ancestor, `false` to match root bins
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorBinTerms
Description	Clears the ancestor bin terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantBinId
Description	Sets the bin `Id` for this query to match bins that have the specified bin as a descendant.
Parameters	`osid.id.Id`	`binid`	a bin `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`binId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBinIdTerms
Description	Clears the descendant bin `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantBinQuery
Description	Tests if a `BinQuery` is available.
Return	`boolean`		`true` if a bin query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantBinQuery
Description	Gets the query for a bin. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.BinQuery`		the bin query
Errors	UNIMPLEMENTED		`supportsDescendantBinQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantBinQuery()` is `true.`
Method	matchAnyDescendantBin
Description	Matches bins with any descendant.
Parameters	`boolean`	`match`	`true` to match bins with any descendant, `false` to match leaf bins
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantBinTerms
Description	Clears the descendant bin terms.
Compliance	`mandatory`		This method must be implemented.
Method	getBinQueryRecord
Description	Gets the bin query record corresponding to the given `Bin` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`binRecordType`	a bin record type
Return	`osid.resource.records.BinQueryRecord`		the bin query record
Errors	NULL_ARGUMENT		`binRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(binRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.