org.osid.dictionary

Interface EntryQuery

All Superinterfaces:

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

public interface EntryQuery
extends OsidObjectQuery

This is the query for searching dictionary entries. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDictionaryIdTerms() Clears the dictionary Id terms.
void	clearDictionaryTerms() Clears the dictionary terms.
void	clearKeyTerms() Clears the key terms.
void	clearKeyTypeTerms() Clears the key type terms.
void	clearValueTerms() Clears the value terms.
void	clearValueTypeTerms() Clears the value type terms.
DictionaryQuery	getDictionaryQuery() Gets the query for a dictionary.
EntryQueryRecord	getEntryQueryRecord(Type entryRecordType) Gets the entry query record corresponding to the given Dictionary record Type.
void	matchDictionaryId(Id dictionaryId, boolean match) Sets the dictionary Id for this query.
void	matchKey(java.lang.Object key, Type keyType, boolean match) Matches entries of this key.
void	matchKeyType(Type keyType, boolean match) Sets the Type for querying keys of a given type.
void	matchValue(java.lang.Object value, Type valueType, boolean match) Sets the value in this entry.
void	matchValueType(Type valueType, boolean match) Sets the Type of this entry value.
boolean	supportsDictionaryQuery() Tests if a DictionaryQuery is available.

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

matchKeyType

void matchKeyType(Type keyType,
                boolean match)

Sets the Type for querying keys of a given type.

Parameters:

keyType - the key Type

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

Throws:

NullArgumentException - keyType is null

Compliance:

mandatory - This method must be implemented.

clearKeyTypeTerms

void clearKeyTypeTerms()

Clears the key type terms.

Compliance:

mandatory - This method must be implemented.

matchKey

void matchKey(java.lang.Object key,
            Type keyType,
            boolean match)

Matches entries of this key.

Parameters:

key - the key

keyType - the key Type

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

Throws:

NullArgumentException - key or keyType is null

Compliance:

mandatory - This method must be implemented.

clearKeyTerms

void clearKeyTerms()

Clears the key terms.

Compliance:

mandatory - This method must be implemented.

matchValueType

void matchValueType(Type valueType,
                  boolean match)

Sets the Type of this entry value.

Parameters:

valueType - the value Type

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

Throws:

NullArgumentException - valueType is null

Compliance:

mandatory - This method must be implemented.

clearValueTypeTerms

void clearValueTypeTerms()

Clears the value type terms.

Compliance:

mandatory - This method must be implemented.

matchValue

void matchValue(java.lang.Object value,
              Type valueType,
              boolean match)

Sets the value in this entry.

Parameters:

value - the value

valueType - the value Type

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

Throws:

NullArgumentException - value or valueType is null

Compliance:

mandatory - This method must be implemented.

clearValueTerms

void clearValueTerms()

Clears the value terms.

Compliance:

mandatory - This method must be implemented.

matchDictionaryId

void matchDictionaryId(Id dictionaryId,
                     boolean match)

Sets the dictionary Id for this query.

Parameters:

dictionaryId - a dictionary Id

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

Throws:

NullArgumentException - dictionaryId is null

Compliance:

mandatory - This method must be implemented.

clearDictionaryIdTerms

void clearDictionaryIdTerms()

Clears the dictionary Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDictionaryQuery

boolean supportsDictionaryQuery()

Tests if a DictionaryQuery is available.

Returns:

true if a dictionary query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDictionaryQuery

DictionaryQuery getDictionaryQuery()

Gets the query for a dictionary. Multiple retrievals produce a nested boolean OR term.

Returns:

the dictionary query

Throws:

UnimplementedException - supportsDictionaryQuery() is false

Compliance:

optional - This method must be implemented if supportsDictionaryQuery() is true.

clearDictionaryTerms

void clearDictionaryTerms()

Clears the dictionary terms.

Compliance:

mandatory - This method must be implemented.

getEntryQueryRecord

EntryQueryRecord getEntryQueryRecord(Type entryRecordType)
                                     throws OperationFailedException

Gets the entry query record corresponding to the given Dictionary record Type. Multiple retrievale produce a nested boolean OR term.

Parameters:

entryRecordType - an entry record type

Returns:

the entry query record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.