org.osid.installation

Interface InstallationContentQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

public interface InstallationContentQuery
extends OsidObjectQuery, OsidSubjugateableQuery

This is the query for searching installation contents. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDataLengthTerms() Clears the data length terms.
void	clearDataTerms() Clears the data terms.
InstallationContentQueryRecord	getInstallationContentQueryRecord(Type installationContentRecordType) Gets the installation content query record corresponding to the given InstallationContent record Type.
void	matchAnyData(boolean match) Matches content that has any data.
void	matchAnyDataLength(boolean match) Matches content that has any data length.
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.

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchDataLength

void matchDataLength(long low,
                   long high,
                   boolean match)

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

Parameters:

low - low range

high - high range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

matchAnyDataLength

void matchAnyDataLength(boolean match)

Matches content that has any data length.

Parameters:

match - true to match content with any data length, false to match content with no data length

Compliance:

mandatory - This method must be implemented.

clearDataLengthTerms

void clearDataLengthTerms()

Clears the data length terms.

Compliance:

mandatory - This method must be implemented.

matchData

void matchData(byte[] data,
             boolean match,
             boolean partial)

Matches data in this content.

Parameters:

data - list of matching strings

match - true for a positive match, false for a negative match

partial - true for a partial match, false for a complete match

Throws:

NullArgumentException - data is null

Compliance:

mandatory - This method must be implemented.

matchAnyData

void matchAnyData(boolean match)

Matches content that has any data.

Parameters:

match - true to match content with any data, false to match content with no data

Compliance:

mandatory - This method must be implemented.

clearDataTerms

void clearDataTerms()

Clears the data terms.

Compliance:

mandatory - This method must be implemented.

getInstallationContentQueryRecord

InstallationContentQueryRecord getInstallationContentQueryRecord(Type installationContentRecordType)
                                                                 throws OperationFailedException

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

Parameters:

installationContentRecordType - an installation content query record type

Returns:

the installation content query record

Throws:

NullArgumentException - installationContentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(installationContentRecordType) is false

Compliance:

mandatory - This method must be implemented.