public interface KeyQuery extends OsidObjectQuery
This is the query for searching keys. Each method specifies an
AND
term while multiple invocations of the same method produce a
nested OR,
except for accessing the KeyQuery
record.
Modifier and Type | Method and Description |
---|---|
void |
clearAgentIdTerms()
Clears the agent
Id terms. |
void |
clearAgentTerms()
Clears the agent terms.
|
AgentQuery |
getAgentQuery()
Includes an agent query for making relations with
Agents. |
KeyQueryRecord |
getKeyQueryRecord(Type keyRecordType)
Gets the key query record corresponding to the given
Key
record Type. |
void |
matchAgentId(Id agentId,
boolean match)
Sets the agent
Id for this query. |
boolean |
supportsAgentQuery()
Tests if an
AgentQuery 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 matchAgentId(Id agentId, boolean match)
Id
for this query.agentId
- an agent Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- agentId
is
null
mandatory
- This method must be implemented. void clearAgentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAgentQuery()
AgentQuery
is available. true
if an agent query is available,
false
otherwisemandatory
- This method must be implemented. AgentQuery getAgentQuery()
Agents.
Multiple retrievals return separate query terms nested inside
this query term, each which are treated as a boolean OR.
UnimplementedException
- supportsAgentQuery()
is false
mandatory
- This method must be implemented. void clearAgentTerms()
mandatory
- This method must be implemented. KeyQueryRecord getKeyQueryRecord(Type keyRecordType) throws OperationFailedException
Key
record Type.
Multiple retrievals produce a
nested OR
term.keyRecordType
- a key record typeNullArgumentException
- keyRecordType
is
null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(keyRecordType)
is false
mandatory
- This method must be implemented.