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.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorSubjectIdTerms()
Clears the ancestor subject
Id terms for this query. |
void |
clearAncestorSubjectTerms()
Clears the ancestor subject terms for this query.
|
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 a 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. |
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 |
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 a
OntologyQuery is available for querying
ontologies. |
boolean |
supportsRelevancyQuery()
Tests if a
RelevancyQuery is available. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchAncestorSubjectId(Id subjectId, boolean match)
Id
for this query to match subjects
that have the specified subject as an ancestor.subjectId
- a subject Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- subjectId
is
null
mandatory
- This method must be implemented. void clearAncestorSubjectIdTerms()
Id
terms for this query.mandatory
- This method must be implemented. boolean supportsAncestorSubjectQuery()
SubjectQuery
is available. true
if a subject query is available,
false
otherwisemandatory
- This method must be implemented. SubjectQuery getAncestorSubjectQuery()
OR
term.UnimplementedException
-
supportsAncestorSubjectQuery()
is false
optional
- This method must be implemented if
supportsAncestorSubjectQuery()
is true.
void matchAnyAncestorSubject(boolean match)
match
- true
to match subjects with any ancestor,
false
to match root subjectsmandatory
- This method must be implemented. void clearAncestorSubjectTerms()
mandatory
- This method must be implemented. void matchDescendantSubjectId(Id subjectId, boolean match)
Id
for this query to match subjects
that have the specified subject as a descendant.subjectId
- a subject Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- subjectId
is
null
mandatory
- This method must be implemented. void clearDescendantSubjectIdTerms()
Id
terms for this query.mandatory
- This method must be implemented. boolean supportsDescendantSubjectQuery()
SubjectQuery
is available. true
if a subject query is available,
false
otherwisemandatory
- This method must be implemented. SubjectQuery getDescendantSubjectQuery()
OR
term.UnimplementedException
-
supportsDescendantSubjectQuery()
is false
optional
- This method must be implemented if
supportsDescendantSubjectQuery()
is true.
void matchAnyDescendantSubject(boolean match)
match
- true
to match subjects with any
descendant, false
to match leaf subjectsmandatory
- This method must be implemented. void clearDescendantSubjectTerms()
mandatory
- This method must be implemented. void matchRelevancyId(Id relevancyId, boolean match)
Id
for this query.relevancyId
- a relevancy Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- relevancyId
is
null
mandatory
- This method must be implemented. void clearRelevancyIdTerms()
Id
terms for this query.mandatory
- This method must be implemented. boolean supportsRelevancyQuery()
RelevancyQuery
is available. true
if a relevancy query is available,
false
otherwisemandatory
- This method must be implemented. RelevancyQuery getRelevancyQuery()
OR
term.UnimplementedException
-
supportsRelevancyQuery()
is false
optional
- This method must be implemented if
supportsRelevancyQuery()
is true.
void matchAnyRelevancy(boolean match)
match
- true
to match ontologies with any
relevancy, false
to match ontologies with no
relevancymandatory
- This method must be implemented. void clearRelevancyTerms()
mandatory
- This method must be implemented. void matchOntologyId(Id ontologyId, boolean match)
Id
for this query.ontologyId
- a ontology Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- ontologyId
is
null
mandatory
- This method must be implemented. void clearOntologyIdTerms()
Id
terms for this query.mandatory
- This method must be implemented. boolean supportsOntologyQuery()
OntologyQuery
is available for querying
ontologies. true
if a ontology query is available,
false
otherwisemandatory
- This method must be implemented. OntologyQuery getOntologyQuery()
OR
term.UnimplementedException
- supportsOntologyQuery()
is false
optional
- This method must be implemented if
supportsOntologyQuery()
is true.
void clearOntologyTerms()
mandatory
- This method must be implemented. SubjectQueryRecord getSubjectQueryRecord(Type subjectRecordType) throws OperationFailedException
Subject
record Type.
Multiple retrievals
produce a nested OR
term.subjectRecordType
- a subject query record typeNullArgumentException
- subjectRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(subjectRecordType)
is false
mandatory
- This method must be implemented.