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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidOperableQuery

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

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRuleQuery

clearConditionRecordTypeTerms, clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyConditionRecordType, matchAnyRule, matchConditionRecordType, matchRuleId, supportsRuleQuery

Modifier and Type	Method	Description
void	clearConditionRecordTypeTerms()	Clears the condition record Type query terms.
void	clearRuleIdTerms()	Clears all rule Id terms.
void	clearRuleTerms()	Clears all rule terms.
RuleQuery	getRuleQuery(boolean match)	Gets the query for the rule.
void	matchAnyConditionRecordType(boolean match)	Matches rules with any condition record type.
void	matchAnyRule(boolean match)	Match any associated rule.
void	matchConditionRecordType(Type conditionRecordType, boolean match)	Matches a condition record type.
void	matchRuleId(Id ruleId, boolean match)	Match the Id of the rule.
boolean	supportsRuleQuery()	Tests if a RuleQuery for the rule is available.

Method Details

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 {@code supportsCyclicEventQuery()} is {@code 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 {@code supportsStockQuery()} is {@code 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 {@code supportsProducedTodoQuery()} is {@code 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 {@code supportsChecklistQuery()} is {@code 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.