public interface AgendaQuery extends OsidObjectQuery
This is the query for searching agendas. Each method match specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearEngineIdTerms()
Clears the engine
Id query terms. |
void |
clearEngineTerms()
Clears the engine query terms.
|
void |
clearInstructionIdTerms()
Clears the instruction
Id query terms. |
void |
clearInstructionTerms()
Clears the instruction query terms.
|
AgendaQueryRecord |
getAgendaQueryRecord(Type agendaRecordType)
Gets the agenda query record corresponding to the given
Agenda
record Type. |
EngineQuery |
getEngineQuery()
Gets the query for an engine.
|
InstructionQuery |
getInstructionQuery()
Gets the query for an instruction.
|
void |
matchAnyInstruction(boolean match)
Matches agendas that have any instruction.
|
void |
matchEngineId(Id engineId,
boolean match)
Sets the engine
Id for this query to match agendas
assigned to engines. |
void |
matchInstructionId(Id qualifierId,
boolean match)
Sets the instruction
Id for this query. |
boolean |
supportsEngineQuery()
Tests if a
EngineQuery is available. |
boolean |
supportsInstructionQuery()
Tests if an
InstructionQuery 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 matchInstructionId(Id qualifierId, boolean match)
Id
for this query.qualifierId
- the instruction Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- instructionId
is
null
mandatory
- This method must be implemented. void clearInstructionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInstructionQuery()
InstructionQuery
is available. true
if an instruction query is available,
false
otherwisemandatory
- This method must be implemented. InstructionQuery getInstructionQuery()
OR
term.UnimplementedException
-
supportsInstructionQuery()
is false
optional
- This method must be implemented if
supportsInstructionQuery()
is true.
void matchAnyInstruction(boolean match)
match
- true
to match agendas with any
instruction, false
to match agendas with no
instructionmandatory
- This method must be implemented. void clearInstructionTerms()
mandatory
- This method must be implemented. void matchEngineId(Id engineId, boolean match)
Id
for this query to match agendas
assigned to engines.engineId
- the engine Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- engineId
is
null
mandatory
- This method must be implemented. void clearEngineIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsEngineQuery()
EngineQuery
is available. true
if an engine query is available,
false
otherwisemandatory
- This method must be implemented. EngineQuery getEngineQuery()
OR
term.UnimplementedException
- supportsEngineQuery()
is false
optional
- This method must be implemented if
supportsEngineQuery()
is true.
void clearEngineTerms()
mandatory
- This method must be implemented. AgendaQueryRecord getAgendaQueryRecord(Type agendaRecordType) throws OperationFailedException, PermissionDeniedException
Agenda
record Type.
Multiple record retrievals produce
a nested OR
term.agendaRecordType
- an agenda record typeNullArgumentException
- agendaRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(agendaRecordType)
is false
mandatory
- This method must be implemented.