Interface IdiomQuery

All Superinterfaces:

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

public interface IdiomQuery
extends OsidObjectQuery, OsidSubjugateableQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearFormatTypeTerms()	Clears the format type query terms.
void	clearLanguageTypeTerms()	Clears the language type query terms.
void	clearPressIdTerms()	Clears the press Id query terms.
void	clearPressTerms()	Clears the press query terms.
void	clearScriptTypeTerms()	Clears the script type query terms.
void	clearTemplateTerms()	Clears the template query terms.
void	clearTextIdTerms()	Clears the text Id query terms.
void	clearTextTerms()	Clears the text query terms.
IdiomQueryRecord	getIdiomQueryRecord(Type idiomRecordType)	Gets the idiom query record corresponding to the given Idiom record Type .Multiple record retrievals produce a nested OR term.
PressQuery	getPressQuery()	Gets the query for an press.
TextQuery	getTextQuery()	Gets the query for a text.
void	matchAnyFormatType(boolean match)	Matches idioms with any known format type.
void	matchAnyLanguageType(boolean match)	Matches idioms with any known language type.
void	matchAnyScriptType(boolean match)	Matches idioms with any known script type.
void	matchAnyTemplate(boolean match)	Matches idioms with any template.
void	matchFormatType(Type formatType, boolean match)	Matches idioms of the given format type.
void	matchLanguageType(Type languageType, boolean match)	Matches idioms of the given language type.
void	matchPressId(Id actionGroupId, boolean match)	Sets the action group Id for this query to match parameters assigned to action groups.
void	matchScriptType(Type scriptType, boolean match)	Matches idioms of the given script type.
void	matchTemplate(String template, Type stringMatchType, boolean match)	Matches idioms of the given template.
void	matchTextId(Id textId, boolean match)	Sets the text Id for this query to match presses that have a related affiliation.
boolean	supportsPressQuery()	Tests if a PressQuery is available.
boolean	supportsTextQuery()	Tests if a TextQuery 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

matchTextId

void matchTextId(Id textId,
 boolean match)

Sets the text Id for this query to match presses that have a related affiliation.

Parameters:

textId - a text Id

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

Throws:

NullArgumentException - textId is null

Compliance:

mandatory - This method must be implemented.

clearTextIdTerms

void clearTextIdTerms()

Clears the text Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsTextQuery

boolean supportsTextQuery()

Tests if a TextQuery is available.

Returns:

true if a text query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTextQuery

TextQuery getTextQuery()

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

Returns:

the text query

Throws:

UnimplementedException - supportsTextQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsTextQuery()} is {@code true} .

clearTextTerms

void clearTextTerms()

Clears the text query terms.

Compliance:

mandatory - This method must be implemented.

matchLanguageType

void matchLanguageType(Type languageType,
 boolean match)

Matches idioms of the given language type.

Parameters:

languageType - a language Type

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

Throws:

NullArgumentException - languageType is null

Compliance:

mandatory - This method must be implemented.

matchAnyLanguageType

void matchAnyLanguageType(boolean match)

Matches idioms with any known language type.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearLanguageTypeTerms

void clearLanguageTypeTerms()

Clears the language type query terms.

Compliance:

mandatory - This method must be implemented.

matchScriptType

void matchScriptType(Type scriptType,
 boolean match)

Matches idioms of the given script type.

Parameters:

scriptType - a script Type

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

Throws:

NullArgumentException - scriptType is null

Compliance:

mandatory - This method must be implemented.

matchAnyScriptType

void matchAnyScriptType(boolean match)

Matches idioms with any known script type.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearScriptTypeTerms

void clearScriptTypeTerms()

Clears the script type query terms.

Compliance:

mandatory - This method must be implemented.

matchFormatType

void matchFormatType(Type formatType,
 boolean match)

Matches idioms of the given format type.

Parameters:

formatType - a format Type

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

Throws:

NullArgumentException - formatType is null

Compliance:

mandatory - This method must be implemented.

matchAnyFormatType

void matchAnyFormatType(boolean match)

Matches idioms with any known format type.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearFormatTypeTerms

void clearFormatTypeTerms()

Clears the format type query terms.

Compliance:

mandatory - This method must be implemented.

matchTemplate

void matchTemplate(String template,
 Type stringMatchType,
 boolean match)

Matches idioms of the given template.

Parameters:

template - a template

stringMatchType - a string match type

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

Throws:

NullArgumentException - template or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyTemplate

void matchAnyTemplate(boolean match)

Matches idioms with any template.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearTemplateTerms

void clearTemplateTerms()

Clears the template query terms.

Compliance:

mandatory - This method must be implemented.

matchPressId

void matchPressId(Id actionGroupId,
 boolean match)

Sets the action group Id for this query to match parameters assigned to action groups.

Parameters:

actionGroupId - the action group Id

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

Throws:

NullArgumentException - actionGroupId is null

Compliance:

mandatory - This method must be implemented.

clearPressIdTerms

void clearPressIdTerms()

Clears the press Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsPressQuery

boolean supportsPressQuery()

Tests if a PressQuery is available.

Returns:

true if an press query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPressQuery

PressQuery getPressQuery()

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

Returns:

the press query

Throws:

UnimplementedException - supportsPressQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPressQuery()} is {@code true} .

clearPressTerms

void clearPressTerms()

Clears the press query terms.

Compliance:

mandatory - This method must be implemented.

getIdiomQueryRecord

IdiomQueryRecord getIdiomQueryRecord(Type idiomRecordType)
                              throws OperationFailedException

Gets the idiom query record corresponding to the given Idiom record Type .Multiple record retrievals produce a nested OR term.

Parameters:

idiomRecordType - an idiom record type

Returns:

the idiom query record

Throws:

NullArgumentException - idiomRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(idiomRecordType) is false

Compliance:

mandatory - This method must be implemented.