org.osid.checklist.mason

Interface TodoProducerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchCreationRule

void matchCreationRule(boolean match)

Matches producers that create todos.

Parameters:

match - true to match creation rules, false to match destruction rules

Compliance:

mandatory - This method must be implemented.

clearCreationRuleTerms

void clearCreationRuleTerms()

Clears the creation rule query terms.

Compliance:

mandatory - This method must be implemented.

matchCyclicEventId

void matchCyclicEventId(Id cyclicEventId,
                      boolean match)

Matches producers based on a cyclic event.

Parameters:

cyclicEventId - the cyclic event Id

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

Throws:

NullArgumentException - cyclicEventId is null

Compliance:

mandatory - This method must be implemented.

clearCyclicEventIdTerms

void clearCyclicEventIdTerms()

Clears the cyclic event Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsCyclicEventQuery

boolean supportsCyclicEventQuery()

Tests if a CyclicEventQuery is available.

Returns:

true if a cyclic event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCyclicEventQuery

CyclicEventQuery getCyclicEventQuery()

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

Returns:

the cyclic event query

Throws:

UnimplementedException - supportsCyclicEventQuery() is false

Compliance:

optional - This method must be implemented if supportsCyclicEventQuery() is true.

matchAnyCyclicEvent

void matchAnyCyclicEvent(boolean match)

Matches producers based on any cyclic event.

Parameters:

match - true for producers based on any cyclic event, false to match producers based on no cyclic event

Compliance:

mandatory - This method must be implemented.

clearCyclicEventTerms

void clearCyclicEventTerms()

Clears the cyclic event query terms.

Compliance:

mandatory - This method must be implemented.

matchStockId

void matchStockId(Id stockId,
                boolean match)

Matches producers based on a stock.

Parameters:

stockId - the stock Id

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

Throws:

NullArgumentException - stockId is null

Compliance:

mandatory - This method must be implemented.

clearStockIdTerms

void clearStockIdTerms()

Clears the stock Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsStockQuery

boolean supportsStockQuery()

Tests if a StockQuery is available.

Returns:

true if a stock query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStockQuery

StockQuery getStockQuery()

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

Returns:

the stock query

Throws:

UnimplementedException - supportsStockQuery() is false

Compliance:

optional - This method must be implemented if supportsStockQuery() is true.

matchAnyStock

void matchAnyStock(boolean match)

Matches producers based on any stock.

Parameters:

match - true for producers based on any stock, false to match producers based on no stock

Compliance:

mandatory - This method must be implemented.

clearStockTerms

void clearStockTerms()

Clears the stock query terms.

Compliance:

mandatory - This method must be implemented.

matchStockLevel

void matchStockLevel(long from,
                   long to,
                   boolean match)

Matches producers with a stock level between the given range inclusive.

Parameters:

from - start of range

to - end of range

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

Throws:

InvalidArgumentException - from is greater than to

Compliance:

mandatory - This method must be implemented.

matchAnyStockLevel

void matchAnyStockLevel(boolean match)

Matches producers with any stock level.

Parameters:

match - true for producers with any stock, false to match producers with no stock

Compliance:

mandatory - This method must be implemented.

clearStockLevelTerms

void clearStockLevelTerms()

Clears the stock level query terms.

Compliance:

mandatory - This method must be implemented.

matchProducedTodoId

void matchProducedTodoId(Id todoId,
                       boolean match)

Matches producers producing to the todo.

Parameters:

todoId - the todo Id

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

Throws:

NullArgumentException - todoBookId is null

Compliance:

mandatory - This method must be implemented.

clearProducedTodoIdTerms

void clearProducedTodoIdTerms()

Clears the produced todo Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsProducedTodoQuery

boolean supportsProducedTodoQuery()

Tests if a TodoBookQuery is available.

Returns:

true if a todo query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProducedTodoQuery

TodoQuery getProducedTodoQuery()

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

Returns:

the todo query

Throws:

UnimplementedException - supportsProducedTodoQuery() is false

Compliance:

optional - This method must be implemented if supportsProducedTodoQuery() is true.

matchAnyProducedTodo

void matchAnyProducedTodo(boolean match)

Matches producers producing to any todo.

Parameters:

match - true for producers producing any todo, false to match producers producing no todo

Compliance:

mandatory - This method must be implemented.

clearProducedTodoTerms

void clearProducedTodoTerms()

Clears the todo query terms.

Compliance:

mandatory - This method must be implemented.

matchChecklistId

void matchChecklistId(Id checklistId,
                    boolean match)

Matches producers mapped to the checklist.

Parameters:

checklistId - the checklist Id

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

Throws:

NullArgumentException - checklistId is null

Compliance:

mandatory - This method must be implemented.

clearChecklistIdTerms

void clearChecklistIdTerms()

Clears the checklist Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsChecklistQuery

boolean supportsChecklistQuery()

Tests if an ChecklistQuery is available.

Returns:

true if a checklist query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getChecklistQuery

ChecklistQuery getChecklistQuery()

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

Returns:

the checklist query

Throws:

UnimplementedException - supportsChecklistQuery() is false

Compliance:

optional - This method must be implemented if supportsChecklistQuery() is true.

clearChecklistTerms

void clearChecklistTerms()

Clears the checklist query terms.

Compliance:

mandatory - This method must be implemented.

getTodoProducerQueryRecord

TodoProducerQueryRecord getTodoProducerQueryRecord(Type todoProducerRecordType)
                                                   throws OperationFailedException

Gets the todo producer query record corresponding to the given TodoProducer record Type. Multiple record retrievals produce a nested OR term.

Parameters:

todoProducerRecordType - a todo producer record type

Returns:

the todo producer query record

Throws:

NullArgumentException - todoProducerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoProducerRecordType) is false

Compliance:

mandatory - This method must be implemented.