OSID - osid.repository.AssetContentQuery Service Interface Definition

Interface	osid.repository.AssetContentQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.repository.AssetContentQuerySession`
	`osid.repository.AssetContentSearchSession`
	`osid.repository.AssetContentSmartRepositorySession`
	`osid.repository.AssetQuery`
	`osid.repository.RepositoryQuery`
Description	This is the query for searching asset contents. Each method forms an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchAssetId
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	clearAssetIdTerms
Description	Clears the asset `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetQuery
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	getAssetQuery
Description	Gets the query for an asset. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.AssetQuery`		the asset query
Errors	UNIMPLEMENTED		`supportsAssetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssetQuery()` is `true`.
Method	clearAssetTerms
Description	Clears the asset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDataLength
Description	Matches content whose length of the data in bytes are inclusive of the given range.
Parameters	`cardinal`	`low`	low range
	`cardinal`	`high`	high range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDataLength
Description	Matches content that has any data length.
Parameters	`boolean`	`match`	`true` to match content with any data length, `false` to match content with no data length
Compliance	`mandatory`		This method must be implemented.
Method	clearDataLengthTerms
Description	Clears the data length terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchData
Description	Matches data in this content.
Parameters	`byte[]`	`data`	list of matching strings
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
	`boolean`	`partial`	`true` for a partial match, `false` for a complete match
Errors	NULL_ARGUMENT		`data` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyData
Description	Matches content that has any data.
Parameters	`boolean`	`match`	`true` to match content with any data, `false` to match content with no data
Compliance	`mandatory`		This method must be implemented.
Method	clearDataTerms
Description	Clears the data terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchURL
Description	Sets the url for this query. Supplying multiple strings behaves like a boolean `OR` among the elements each which must correspond to the `stringMatchType`.
Parameters	`string`	`url`	url 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		`url` not of `stringMatchType`
	NULL_ARGUMENT		`url` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(url)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyURL
Description	Matches content that has any url.
Parameters	`boolean`	`match`	`true` to match content with any url, `false` to match content with no url
Compliance	`mandatory`		This method must be implemented.
Method	clearURLTerms
Description	Clears the url terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAssetContentQueryRecord
Description	Gets the asset content query record corresponding to the given `AssetContent` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`assetContentRecordType`	an asset content record type
Return	`osid.repository.records.AssetContentQueryRecord`		the asset content query record
Errors	NULL_ARGUMENT		`assetContentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assetContentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.