org.osid.dictionary

Interface DictionaryQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface DictionaryQuery
extends OsidCatalogQuery

This is the query for searching dictionaries. 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	clearAncestorDictionaryIdTerms() Clears the ancestor dictionary Id terms.
void	clearAncestorDictionaryTerms() Clears the ancestor dictionary terms.
void	clearDescendantDictionaryIdTerms() Clears the dictionary Id terms.
void	clearDescendantDictionaryTerms() Clears the dictionary terms.
void	clearEntryIdTerms() Clears the entry Id terms.
void	clearEntryTerms() Clears the entry terms.
DictionaryQuery	getAncestorDictionaryQuery() Gets the query for an ancestor dictionary.
DictionaryQuery	getDescendantDictionaryQuery() Gets the query for a descendant dictioonary.
DictionaryQueryRecord	getDictionaryQueryRecord(Type dictionaryRecordType) Gets the dictionary query record corresponding to the given Dictionary record Type.
EntryQuery	getEntryQuery() Gets the query for an entry.
void	matchAncestorDictionaryId(Id dictionaryId, boolean match) Sets the dictionary Id for to match dictionaries in which the specified dictionary is an acestor.
void	matchAnyAncestorDictionary(boolean match) Matches a dictionary that has any ancestor.
void	matchAnyDescendantDictionary(boolean match) Matches a dictionary that has any descendant.
void	matchAnyEntry(boolean match) Matches dictionaries with any entry.
void	matchDescendantDictionaryId(Id dictionaryId, boolean match) Sets the dictionary Id for to match dictionaries in which the specified dictionary is a descendant.
void	matchEntryId(Id entryId, boolean match) Sets the entry Id.
boolean	supportsAncestorDictionaryQuery() Tests if a DictionaryQuery is available.
boolean	supportsDescendantDictionaryQuery() Tests if a DictionaryQuery is available.
boolean	supportsEntryQuery() Tests if an EntryQuery 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

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchEntryId

void matchEntryId(Id entryId,
                boolean match)

Sets the entry Id.

Parameters:

entryId - an entry Id

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

Throws:

NullArgumentException - entryId is null

Compliance:

mandatory - This method must be implemented.

clearEntryIdTerms

void clearEntryIdTerms()

Clears the entry Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEntryQuery

boolean supportsEntryQuery()

Tests if an EntryQuery is available.

Returns:

true if an entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEntryQuery

EntryQuery getEntryQuery()

Gets the query for an entry. Multiple retrievale produce a nested boolean OR term.

Returns:

the entry query

Throws:

UnimplementedException - supportsEntryQuery() is false

Compliance:

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

matchAnyEntry

void matchAnyEntry(boolean match)

Matches dictionaries with any entry.

Parameters:

match - true to match dictionaries with any entry, false to match dictionaries with no entry

Compliance:

mandatory - This method must be implemented.

clearEntryTerms

void clearEntryTerms()

Clears the entry terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorDictionaryId

void matchAncestorDictionaryId(Id dictionaryId,
                             boolean match)

Sets the dictionary Id for to match dictionaries in which the specified dictionary is an acestor.

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.

clearAncestorDictionaryIdTerms

void clearAncestorDictionaryIdTerms()

Clears the ancestor dictionary Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorDictionaryQuery

boolean supportsAncestorDictionaryQuery()

Tests if a DictionaryQuery is available.

Returns:

true if a dictionary query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorDictionaryQuery

DictionaryQuery getAncestorDictionaryQuery()

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

Returns:

the dictionary query

Throws:

UnimplementedException - supportsAncestorDictionaryQuery() is false

Compliance:

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

matchAnyAncestorDictionary

void matchAnyAncestorDictionary(boolean match)

Matches a dictionary that has any ancestor.

Parameters:

match - true to match dictionaries with any ancestor dictionaries, false to match root dictionaries

Compliance:

mandatory - This method must be implemented.

clearAncestorDictionaryTerms

void clearAncestorDictionaryTerms()

Clears the ancestor dictionary terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantDictionaryId

void matchDescendantDictionaryId(Id dictionaryId,
                               boolean match)

Sets the dictionary Id for to match dictionaries in which the specified dictionary is a descendant.

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.

clearDescendantDictionaryIdTerms

void clearDescendantDictionaryIdTerms()

Clears the dictionary Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantDictionaryQuery

boolean supportsDescendantDictionaryQuery()

Tests if a DictionaryQuery is available.

Returns:

true if a dictionary query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantDictionaryQuery

DictionaryQuery getDescendantDictionaryQuery()

Gets the query for a descendant dictioonary. Multiple retrievals produce a nested OR term.

Returns:

the dictionary query

Throws:

UnimplementedException - supportsDescendantDictionaryQuery() is false

Compliance:

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

matchAnyDescendantDictionary

void matchAnyDescendantDictionary(boolean match)

Matches a dictionary that has any descendant.

Parameters:

match - true to match dictionaries with any descendant dictionaries, false to match leaf dictionaries

Compliance:

mandatory - This method must be implemented.

clearDescendantDictionaryTerms

void clearDescendantDictionaryTerms()

Clears the dictionary terms.

Compliance:

mandatory - This method must be implemented.

getDictionaryQueryRecord

DictionaryQueryRecord getDictionaryQueryRecord(Type dictionaryRecordType)
                                               throws OperationFailedException

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

Parameters:

dictionaryRecordType - a dictionary record type

Returns:

the dictionary query record

Throws:

NullArgumentException - dictionaryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dictionaryRecordType) is false

Compliance:

mandatory - This method must be implemented.