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

Modifier and Type	Method	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(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(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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

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(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(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 {@code supportsDictionaryQuery()} is {@code 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.