OSID - osid.resource.ResourceQuery Service Interface Definition

Interface	osid.resource.ResourceQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching resources. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchGroup
Description	Matches resources that are also groups.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearGroupTerms
Description	Clears the group terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDemographic
Description	Matches resources that are also demographics.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearDemographicTerms
Description	Clears the demographic terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchContainingGroupId
Description	Sets the group `Id` for this query to match resources within the given group.
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	clearContainingGroupIdTerms
Description	Clears the group `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsContainingGroupQuery
Description	Tests if a `ResourceQuery` is available for querying containing groups.
Return	`boolean`		`true` if a group resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getContainingGroupQuery
Description	Gets the query for a a containing group. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsContainingGroupQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentQuery()` is `true.`
Method	matchAnyContainingGroup
Description	Matches resources inside any group.
Parameters	`boolean`	`match`	`true` to match any containing group, `false` to match resources part of no groups
Compliance	`mandatory`		This method must be implemented.
Method	clearContainingGroupTerms
Description	Clears the containing group terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAvatarId
Description	Sets the asset `Id` for this query.
Parameters	`osid.id.Id`	`assetId`	the asset `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAvatarIdTerms
Description	Clears the asset `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAvatarQuery
Description	Tests if an `AssetQuery` is available.
Return	`boolean`		`true` if an asset query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAvatarQuery
Description	Gets the query for an asset. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.AssetQuery`		the asset query
Errors	UNIMPLEMENTED		`supportsAvatarQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAvatarQuery()` is `true.`
Method	matchAnyAvatar
Description	Matches resources with any asset.
Parameters	`boolean`	`match`	`true` to match any asset, `false` to match resources with no asset
Compliance	`mandatory`		This method must be implemented.
Method	clearAvatarTerms
Description	Clears the asset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAgentId
Description	Sets the agent `Id` for this query.
Parameters	`osid.id.Id`	`agentId`	the agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAgentIdTerms
Description	Clears the agent `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentQuery
Description	Tests if an `AgentQuery` is available.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentQuery
Description	Gets the query for an agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentQuery()` is `true.`
Method	matchAnyAgent
Description	Matches resources with any agent.
Parameters	`boolean`	`match`	`true` to match any agent, `false` to match resources with no agent
Compliance	`mandatory`		This method must be implemented.
Method	clearAgentTerms
Description	Clears the agent terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResourceRelationshipId
Description	Sets the resource relationship `Id` for this query.
Parameters	`osid.id.Id`	`resourceRelationshipId`	the resource relationship `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceRelationshipId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceRelationshipIdTerms
Description	Clears the resource relationship `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceRelationshipQuery
Description	Tests if a `ResourceRelationshipQuery` is available.
Return	`boolean`		`true` if a resource relationship query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipQuery
Description	Gets the query for aa resource relationship. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceRelationshipQuery`		the resource relationship query
Errors	UNIMPLEMENTED		`supportsResourceRelationshipQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceRelationshipQuery()` is `true.`
Method	matchAnyResourceRelationship
Description	Matches resources with any resource relationship.
Parameters	`boolean`	`match`	`true` to match any resource relationship, `false` to match resources with no relationship
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceRelationshipTerms
Description	Clears the resource relationship terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBinId
Description	Sets the bin `Id` for this query.
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	getResourceQueryRecord
Description	Gets the resource query record corresponding to the given `Resource` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`resourceRecordType`	a resource record type
Return	`osid.resource.records.ResourceQueryRecord`		the resource query record
Errors	NULL_ARGUMENT		`resourceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(resourceRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.