Interface SubjectQuery

All Superinterfaces:

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

public interface SubjectQuery
extends OsidObjectQuery, OsidFederateableQuery

This is the query for searching subjects. Each method match request produces an AND term while multiple invocations of a method produces a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearAncestorSubjectIdTerms()	Clears the ancestor subject Id terms for this query.
void	clearAncestorSubjectTerms()	Clears the ancestor subject terms for this query.
void	clearCodeTerms()	Clears the code terms.
void	clearDescendantSubjectIdTerms()	Clears the descendant subject Id terms for this query.
void	clearDescendantSubjectTerms()	Clears the descendant subject terms for this query.
void	clearOntologyIdTerms()	Clears the ontology Id terms for this query.
void	clearOntologyTerms()	Clears the ontology terms for this query.
void	clearRelevancyIdTerms()	Clears the relevancy Id terms for this query.
void	clearRelevancyTerms()	Clears the relevancy terms for this query.
SubjectQuery	getAncestorSubjectQuery()	Gets the query for a subject.
SubjectQuery	getDescendantSubjectQuery()	Gets the query for a subject.
OntologyQuery	getOntologyQuery()	Gets the query for an ontology.
RelevancyQuery	getRelevancyQuery()	Gets the query for a relevancy.
SubjectQueryRecord	getSubjectQueryRecord(Type subjectRecordType)	Gets the subject query record corresponding to the given Subject record Type .Multiple retrievals produce a nested OR term.
void	matchAncestorSubjectId(Id subjectId, boolean match)	Sets the subject Id for this query to match subjects that have the specified subject as an ancestor.
void	matchAnyAncestorSubject(boolean match)	Matches subjects with any ancestor.
void	matchAnyDescendantSubject(boolean match)	Matches subjects with any descendant.
void	matchAnyRelevancy(boolean match)	Matches ontologies that have any relevancy.
void	matchCode(String code, Type stringMatchType, boolean match)	Matches the subject code.
void	matchDescendantSubjectId(Id subjectId, boolean match)	Sets the subject Id for this query to match subjects that have the specified subject as a descendant.
void	matchOntologyId(Id ontologyId, boolean match)	Sets the ontology Id for this query.
void	matchRelevancyId(Id relevancyId, boolean match)	Sets the relevancy Id for this query.
boolean	supportsAncestorSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsDescendantSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsOntologyQuery()	Tests if an OntologyQuery is available for querying ontologies.
boolean	supportsRelevancyQuery()	Tests if a RelevancyQuery 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

matchCode

void matchCode(String code,
 Type stringMatchType,
 boolean match)

Matches the subject code.

Parameters:

code - the code string

stringMatchType - a string match type

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

Throws:

NullArgumentException - code or stringMatchType is null

Compliance:

mandatory - This method must be implemented.

clearCodeTerms

void clearCodeTerms()

Clears the code terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorSubjectId

void matchAncestorSubjectId(Id subjectId,
 boolean match)

Sets the subject Id for this query to match subjects that have the specified subject as an ancestor.

Parameters:

subjectId - a subject Id

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

Throws:

NullArgumentException - subjectId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorSubjectIdTerms

void clearAncestorSubjectIdTerms()

Clears the ancestor subject Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsAncestorSubjectQuery

boolean supportsAncestorSubjectQuery()

Tests if a SubjectQuery is available.

Returns:

true if a subject query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorSubjectQuery

SubjectQuery getAncestorSubjectQuery()

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

Returns:

the subject query

Throws:

UnimplementedException - supportsAncestorSubjectQuery() is false

Compliance:

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

matchAnyAncestorSubject

void matchAnyAncestorSubject(boolean match)

Matches subjects with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorSubjectTerms

void clearAncestorSubjectTerms()

Clears the ancestor subject terms for this query.

Compliance:

mandatory - This method must be implemented.

matchDescendantSubjectId

void matchDescendantSubjectId(Id subjectId,
 boolean match)

Sets the subject Id for this query to match subjects that have the specified subject as a descendant.

Parameters:

subjectId - a subject Id

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

Throws:

NullArgumentException - subjectId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantSubjectIdTerms

void clearDescendantSubjectIdTerms()

Clears the descendant subject Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsDescendantSubjectQuery

boolean supportsDescendantSubjectQuery()

Tests if a SubjectQuery is available.

Returns:

true if a subject query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantSubjectQuery

SubjectQuery getDescendantSubjectQuery()

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

Returns:

the subject query

Throws:

UnimplementedException - supportsDescendantSubjectQuery() is false

Compliance:

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

matchAnyDescendantSubject

void matchAnyDescendantSubject(boolean match)

Matches subjects with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantSubjectTerms

void clearDescendantSubjectTerms()

Clears the descendant subject terms for this query.

Compliance:

mandatory - This method must be implemented.

matchRelevancyId

void matchRelevancyId(Id relevancyId,
 boolean match)

Sets the relevancy Id for this query.

Parameters:

relevancyId - a relevancy Id

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

Throws:

NullArgumentException - relevancyId is null

Compliance:

mandatory - This method must be implemented.

clearRelevancyIdTerms

void clearRelevancyIdTerms()

Clears the relevancy Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsRelevancyQuery

boolean supportsRelevancyQuery()

Tests if a RelevancyQuery is available.

Returns:

true if a relevancy query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRelevancyQuery

RelevancyQuery getRelevancyQuery()

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

Returns:

the relevancy query

Throws:

UnimplementedException - supportsRelevancyQuery() is false

Compliance:

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

matchAnyRelevancy

void matchAnyRelevancy(boolean match)

Matches ontologies that have any relevancy.

Parameters:

match - true to match ontologies with any relevancy, false to match ontologies with no relevancy

Compliance:

mandatory - This method must be implemented.

clearRelevancyTerms

void clearRelevancyTerms()

Clears the relevancy terms for this query.

Compliance:

mandatory - This method must be implemented.

matchOntologyId

void matchOntologyId(Id ontologyId,
 boolean match)

Sets the ontology Id for this query.

Parameters:

ontologyId - an ontology Id

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

Throws:

NullArgumentException - ontologyId is null

Compliance:

mandatory - This method must be implemented.

clearOntologyIdTerms

void clearOntologyIdTerms()

Clears the ontology Id terms for this query.

Compliance:

mandatory - This method must be implemented.

supportsOntologyQuery

boolean supportsOntologyQuery()

Tests if an OntologyQuery is available for querying ontologies.

Returns:

true if an ontology query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOntologyQuery

OntologyQuery getOntologyQuery()

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

Returns:

the ontology query

Throws:

UnimplementedException - supportsOntologyQuery() is false

Compliance:

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

clearOntologyTerms

void clearOntologyTerms()

Clears the ontology terms for this query.

Compliance:

mandatory - This method must be implemented.

getSubjectQueryRecord

SubjectQueryRecord getSubjectQueryRecord(Type subjectRecordType)
                                  throws OperationFailedException

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

Parameters:

subjectRecordType - a subject query record type

Returns:

the subject query record

Throws:

NullArgumentException - subjectRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subjectRecordType) is false

Compliance:

mandatory - This method must be implemented.