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

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

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

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