public interface TodoProducerQuery extends OsidRuleQuery
This is the query for searching todo producers. 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 |
clearChecklistIdTerms()
Clears the checklist
Id query terms. |
void |
clearChecklistTerms()
Clears the checklist query terms.
|
void |
clearCreationRuleTerms()
Clears the creation rule query terms.
|
void |
clearCyclicEventIdTerms()
Clears the cyclic event
Id query terms. |
void |
clearCyclicEventTerms()
Clears the cyclic event query terms.
|
void |
clearProducedTodoIdTerms()
Clears the produced todo
Id query terms. |
void |
clearProducedTodoTerms()
Clears the todo query terms.
|
void |
clearStockIdTerms()
Clears the stock
Id query terms. |
void |
clearStockLevelTerms()
Clears the stock level query terms.
|
void |
clearStockTerms()
Clears the stock query terms.
|
ChecklistQuery |
getChecklistQuery()
Gets the query for a checklist.
|
CyclicEventQuery |
getCyclicEventQuery()
Gets the query for a cyclic event.
|
TodoQuery |
getProducedTodoQuery()
Gets the query for a todo.
|
StockQuery |
getStockQuery()
Gets the query for a stock.
|
TodoProducerQueryRecord |
getTodoProducerQueryRecord(Type todoProducerRecordType)
Gets the todo producer query record corresponding to the given
TodoProducer record Type. |
void |
matchAnyCyclicEvent(boolean match)
Matches producers based on any cyclic event.
|
void |
matchAnyProducedTodo(boolean match)
Matches producers producing to any todo.
|
void |
matchAnyStock(boolean match)
Matches producers based on any stock.
|
void |
matchAnyStockLevel(boolean match)
Matches producers with any stock level.
|
void |
matchChecklistId(Id checklistId,
boolean match)
Matches producers mapped to the checklist.
|
void |
matchCreationRule(boolean match)
Matches producers that create todos.
|
void |
matchCyclicEventId(Id cyclicEventId,
boolean match)
Matches producers based on a cyclic event.
|
void |
matchProducedTodoId(Id todoId,
boolean match)
Matches producers producing to the todo.
|
void |
matchStockId(Id stockId,
boolean match)
Matches producers based on a stock.
|
void |
matchStockLevel(long from,
long to,
boolean match)
Matches producers with a stock level between the given range
inclusive.
|
boolean |
supportsChecklistQuery()
Tests if an
ChecklistQuery is available. |
boolean |
supportsCyclicEventQuery()
Tests if a
CyclicEventQuery is available. |
boolean |
supportsProducedTodoQuery()
Tests if a
TodoBookQuery is available. |
boolean |
supportsStockQuery()
Tests if a
StockQuery is available. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchCreationRule(boolean match)
match
- true
to match creation rules,
false
to match destruction rulesmandatory
- This method must be implemented. void clearCreationRuleTerms()
mandatory
- This method must be implemented. void matchCyclicEventId(Id cyclicEventId, boolean match)
cyclicEventId
- the cyclic event Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- cyclicEventId
is
null
mandatory
- This method must be implemented. void clearCyclicEventIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsCyclicEventQuery()
CyclicEventQuery
is available. true
if a cyclic event query is available,
false
otherwisemandatory
- This method must be implemented. CyclicEventQuery getCyclicEventQuery()
OR
term.UnimplementedException
-
supportsCyclicEventQuery()
is false
optional
- This method must be implemented if
supportsCyclicEventQuery()
is true.
void matchAnyCyclicEvent(boolean match)
match
- true
for producers based on any cyclic
event, false
to match producers based on no
cyclic eventmandatory
- This method must be implemented. void clearCyclicEventTerms()
mandatory
- This method must be implemented. void matchStockId(Id stockId, boolean match)
stockId
- the stock Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stockId
is
null
mandatory
- This method must be implemented. void clearStockIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsStockQuery()
StockQuery
is available. true
if a stock query is available,
false
otherwisemandatory
- This method must be implemented. StockQuery getStockQuery()
OR
term.UnimplementedException
- supportsStockQuery()
is false
optional
- This method must be implemented if
supportsStockQuery()
is true.
void matchAnyStock(boolean match)
match
- true
for producers based on any stock,
false
to match producers based on no stockmandatory
- This method must be implemented. void clearStockTerms()
mandatory
- This method must be implemented. void matchStockLevel(long from, long to, boolean match)
from
- start of rangeto
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
mandatory
- This method must be implemented. void matchAnyStockLevel(boolean match)
match
- true
for producers with any stock,
false
to match producers with no stockmandatory
- This method must be implemented. void clearStockLevelTerms()
mandatory
- This method must be implemented. void matchProducedTodoId(Id todoId, boolean match)
todoId
- the todo Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- todoBookId
is
null
mandatory
- This method must be implemented. void clearProducedTodoIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsProducedTodoQuery()
TodoBookQuery
is available. true
if a todo query is available, false
otherwisemandatory
- This method must be implemented. TodoQuery getProducedTodoQuery()
OR
term.UnimplementedException
-
supportsProducedTodoQuery()
is false
optional
- This method must be implemented if
supportsProducedTodoQuery()
is true.
void matchAnyProducedTodo(boolean match)
match
- true
for producers producing any todo,
false
to match producers producing no todomandatory
- This method must be implemented. void clearProducedTodoTerms()
mandatory
- This method must be implemented. void matchChecklistId(Id checklistId, boolean match)
checklistId
- the checklist Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- checklistId
is
null
mandatory
- This method must be implemented. void clearChecklistIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsChecklistQuery()
ChecklistQuery
is available. true
if a checklist query is available,
false
otherwisemandatory
- This method must be implemented. ChecklistQuery getChecklistQuery()
OR
term.UnimplementedException
-
supportsChecklistQuery()
is false
optional
- This method must be implemented if
supportsChecklistQuery()
is true.
void clearChecklistTerms()
mandatory
- This method must be implemented. TodoProducerQueryRecord getTodoProducerQueryRecord(Type todoProducerRecordType) throws OperationFailedException
TodoProducer
record Type.
Multiple record
retrievals produce a nested OR
term.todoProducerRecordType
- a todo producer record typeNullArgumentException
- todoProducerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(todoProducerRecordType)
is false
mandatory
- This method must be implemented.