OSID - osid.resource.ResourceRelationshipQuery Service Interface Definition

Interface	osid.resource.ResourceRelationshipQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.resource.ResourceQuery`
	`osid.resource.ResourceRelationshipQuerySession`
	`osid.resource.ResourceRelationshipSearchSession`
	`osid.resource.ResourceRelationshipSmartBinSession`
Description	This is the query for searching resource relationships. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`.
Method	matchSourceResourceId
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	clearSourceResourceIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSourceResourceQuery
Description	Tests if a `ResourceQuery` is available for querying resources.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSourceResourceQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsSourceResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSourceResourceQuery()` is `true`.
Method	clearSourceResourceTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDestinationResourceId
Description	Sets the peer resource `Id` for this query.
Parameters	`osid.id.Id`	`peerResourceId`	a peer resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`peerResourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDestinationResourceIdTerms
Description	Clears the peer resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDestinationResourceQuery
Description	Tests if a `ResourceQuery` is available for querying resources.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDestinationResourceQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsDestinationResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDestinationResourceQuery()` is `true`.
Method	clearDestinationResourceTerms
Description	Clears the peer resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSameResource
Description	Matches relationships where the peer resources are the same.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearSameResourceTerms
Description	Clears the same resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBinId
Description	Sets the bin `Id` for this query to match terms assigned to bins.
Parameters	`osid.id.Id`	`binId`	the 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	clearBinIdTerms
Description	Clears the bin `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBinQuery
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	getBinQuery
Description	Gets the query for a bin. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.BinQuery`		the bin query
Errors	UNIMPLEMENTED		`supportsBinQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBinQuery()` is `true`.
Method	clearBinTerms
Description	Clears the bin terms.
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipQueryRecord
Description	Gets the resource relationship query record corresponding to the given `ResourceRelationship` record `Type` . Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`resourceRelationshipRecordType`	a resource relationship query record type
Return	`osid.resource.records.ResourceRelationshipQueryRecord`		the resource relationship query record
Errors	NULL_ARGUMENT		`resourceRelationshipRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(resourceRelationshipRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.