OSID - osid.OsidSourceableQuery Service Interface Definition

Interface	osid.OsidSourceableQuery
Implements	`osid.OsidQuery`
Description	The `OsidSourceableQuery` is used to assemble search queries for sourceables.
Method	matchProviderId
Description	Match the `Id` of the provider resource.
Parameters	`osid.id.Id`	`resourceId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProviderIdTerms
Description	Clears all provider `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProviderQuery
Description	Tests if a `ResourceQuery` for the provider is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProviderQuery
Description	Gets the query for the provider. Each retrieval performs a boolean `OR.`
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.resource.ResourceQuery`		the provider query
Errors	UNIMPLEMENTED		`supportsProviderQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProviderQuery()` is `true.`
Method	matchAnyProvider
Description	Match sourceables with a provider value.
Parameters	`boolean`	`match`	`true` to match sourceables with any provider, `false` to match sourceables with no providers
Compliance	`mandatory`		This method must be implemented.
Method	clearProviderTerms
Description	Clears all provider terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBrandingId
Description	Match the `Id` of an asset used for branding.
Parameters	`osid.id.Id`	`assetId`	`Id` to match
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBrandingIdTerms
Description	Clears all asset `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBrandingQuery
Description	Tests if an `AssetQuery` for the branding is available.
Return	`boolean`		`true` if a asset query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBrandingQuery
Description	Gets the query for an asset. Each retrieval performs a boolean `OR.`
Parameters	`boolean`	`match`	`true` if for a positive match, `false` for a negative match
Return	`osid.repository.AssetQuery`		the asset query
Errors	UNIMPLEMENTED		`supportsBrandingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBrandingQuery()` is `true.`
Method	matchAnyBranding
Description	Match sourceables with any branding.
Parameters	`boolean`	`match`	`true` to match any asset, `false` to match no assets
Compliance	`mandatory`		This method must be implemented.
Method	clearBrandingTerms
Description	Clears all branding terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLicense
Description	Adds a license to match. Multiple license matches can be added to perform a boolean `OR` among them.
Parameters	`string`	`license`	a string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`license` is not of `stringMatchType`
	NULL_ARGUMENT		`license` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyLicense
Description	Matches any object with a license.
Parameters	`boolean`	`match`	`true` to match any license, `false` to match objects with no license
Compliance	`mandatory`		This method must be implemented.
Method	clearLicenseTerms
Description	Clears all license terms.
Compliance	`mandatory`		This method must be implemented.