public interface AssetContentQuery extends OsidObjectQuery, OsidSubjugateableQuery
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.
Modifier and Type | Method and Description |
---|---|
void |
clearAccessibilityTypeTerms()
Clears the accessibility terms.
|
void |
clearDataLengthTerms()
Clears the data length terms.
|
void |
clearDataTerms()
Clears the data terms.
|
void |
clearURLTerms()
Clears the url terms.
|
AssetContentQueryRecord |
getAssetContentQueryRecord(Type assetContentRecordType)
Gets the asset content query record corresponding to the given
AssetContent record Type. |
void |
matchAccessibilityType(Type accessibilityType,
boolean match)
Sets the accessibility types for this query.
|
void |
matchAnyAccessibilityType(boolean match)
Matches asset content that has any accessibility type.
|
void |
matchAnyData(boolean match)
Matches content that has any data.
|
void |
matchAnyDataLength(boolean match)
Matches content that has any data length.
|
void |
matchAnyURL(boolean match)
Matches content that has any url.
|
void |
matchData(byte[] data,
boolean match,
boolean partial)
Matches data in this content.
|
void |
matchDataLength(long low,
long high,
boolean match)
Matches content whose length of the data in bytes are inclusive of the
given range.
|
void |
matchURL(java.lang.String url,
Type stringMatchType,
boolean match)
Sets the url for this query.
|
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchAccessibilityType(Type accessibilityType, boolean match)
accessibilityType
- an accessibilityTypematch
- true
for a positive match, false
for a negative matchNullArgumentException
- accessibilityType
is null
mandatory
- This method must be implemented. void matchAnyAccessibilityType(boolean match)
match
- true
to match content with any
accessibility type, false
to match content with
no accessibility typemandatory
- This method must be implemented. void clearAccessibilityTypeTerms()
mandatory
- This method must be implemented. void matchDataLength(long low, long high, boolean match)
low
- low rangehigh
- high rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void matchAnyDataLength(boolean match)
match
- true
to match content with any data
length, false
to match content with no data
lengthmandatory
- This method must be implemented. void clearDataLengthTerms()
mandatory
- This method must be implemented. void matchData(byte[] data, boolean match, boolean partial)
data
- list of matching stringsmatch
- true
for a positive match, false
for a negative matchpartial
- true
for a partial match, false
for a complete matchNullArgumentException
- data
is
null
mandatory
- This method must be implemented. void matchAnyData(boolean match)
match
- true
to match content with any data,
false
to match content with no datamandatory
- This method must be implemented. void clearDataTerms()
mandatory
- This method must be implemented. void matchURL(java.lang.String url, Type stringMatchType, boolean match)
OR
among the elements each which must
correspond to the stringMatchType.
url
- url string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- url
not of
stringMatchType
NullArgumentException
- url
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(url)
is false
mandatory
- This method must be implemented. void matchAnyURL(boolean match)
match
- true
to match content with any url,
false
to match content with no urlmandatory
- This method must be implemented. void clearURLTerms()
mandatory
- This method must be implemented. AssetContentQueryRecord getAssetContentQueryRecord(Type assetContentRecordType) throws OperationFailedException
AssetContent
record Type.
Multiple record
retrievals produce a nested OR
term.assetContentRecordType
- an asset content record typeNullArgumentException
- assetContentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(assetContentRecordType)
is false
mandatory
- This method must be implemented.