OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.AssetContentQuery
Implementsosid.OsidObjectQuery
osid.OsidSubjugateableQuery
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.

MethodmatchAccessibilityType
Description

Sets the accessibility types for this query. Supplying multiple types behaves like a boolean OR among the elements.

Parametersosid.type.TypeaccessibilityTypean accessibilityType
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT accessibilityType is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyAccessibilityType
Description

Matches asset content that has any accessibility type.

Parametersbooleanmatch true to match content with any accessibility type, false to match content with no accessibility type
CompliancemandatoryThis method must be implemented.
MethodclearAccessibilityTypeTerms
Description

Clears the accessibility terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDataLength
Description

Matches content whose length of the data in bytes are inclusive of the given range.

Parameterscardinallowlow range
cardinalhighhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodmatchAnyDataLength
Description

Matches content that has any data length.

Parametersbooleanmatch true to match content with any data length, false to match content with no data length
CompliancemandatoryThis method must be implemented.
MethodclearDataLengthTerms
Description

Clears the data length terms.

CompliancemandatoryThis method must be implemented.
MethodmatchData
Description

Matches data in this content.

Parametersbyte[]datalist of matching strings
booleanmatch true for a positive match, false for a negative match
booleanpartial true for a partial match, false for a complete match
ErrorsNULL_ARGUMENT data is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyData
Description

Matches content that has any data.

Parametersbooleanmatch true to match content with any data, false to match content with no data
CompliancemandatoryThis method must be implemented.
MethodclearDataTerms
Description

Clears the data terms.

CompliancemandatoryThis method must be implemented.
MethodmatchURL
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.

Parametersstringurlurl string to match
osid.type.TypestringMatchTypethe string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT url not of stringMatchType
NULL_ARGUMENT url or stringMatchType is null
UNSUPPORTED supportsStringMatchType(url) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyURL
Description

Matches content that has any url.

Parametersbooleanmatch true to match content with any url, false to match content with no url
CompliancemandatoryThis method must be implemented.
MethodclearURLTerms
Description

Clears the url terms.

CompliancemandatoryThis method must be implemented.
MethodgetAssetContentQueryRecord
Description

Gets the asset content query record corresponding to the given AssetContent record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeassetContentRecordTypean asset content record type
Returnosid.repository.records.AssetContentQueryRecordthe asset content query record
ErrorsNULL_ARGUMENT assetContentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(assetContentRecordType) is false
CompliancemandatoryThis method must be implemented.