Interface TodoQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidContainableQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidTemporalQuery, Suppliable

public interface TodoQuery
extends OsidObjectQuery, OsidContainableQuery, OsidTemporalQuery, OsidFederateableQuery

This is the query for searching todos. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearAncestorTodoIdTerms()	Clears the ancestor todo Id query terms.
void	clearAncestorTodoTerms()	Clears the ancestor todo query terms.
void	clearChecklistIdTerms()	Clears the checklist Id terms.
void	clearChecklistTerms()	Clears the checklist terms.
void	clearCompleteTerms()	Clears the complete terms.
void	clearDependencyIdTerms()	Clears the todo Id terms.
void	clearDependencyTerms()	Clears the dependency terms.
void	clearDescendantTodoIdTerms()	Clears the descendant todo Id query terms.
void	clearDescendantTodoTerms()	Clears the descendant todo query terms.
void	clearDueDateTerms()	Clears the due date terms.
void	clearMinimumPriorityTerms()	Clears the minimum priority terms.
void	clearPriorityTerms()	Clears the priority terms.
TodoQuery	getAncestorTodoQuery()	Gets the query for a todo.
ChecklistQuery	getChecklistQuery()	Gets the query for a checklist query.
TodoQuery	getDependencyQuery()	Gets the query for a todo query.
TodoQuery	getDescendantTodoQuery()	Gets the query for a todo.
TodoQueryRecord	getTodoQueryRecord(Type todoRecordType)	Gets the todo query record corresponding to the given Todo record Type .Multiple record retrievals produce a nested OR term.
void	matchAncestorTodoId(Id todoId, boolean match)	Sets the todo Id for this query to match todos that have the specified todo as an ancestor.
void	matchAnyAncestorTodo(boolean match)	Matches todos that have any ancestor.
void	matchAnyDependency(boolean match)	Matches tdos with any dependencies.
void	matchAnyDescendantTodo(boolean match)	Matches todos that have any descendant.
void	matchAnyDueDate(boolean match)	Matches todos with any due date.
void	matchAnyPriority(boolean match)	Matches todos with any priority set.
void	matchChecklistId(Id checklistId, boolean match)	Sets the checklist Id for this query to match todos assigned to checklists.
void	matchComplete(boolean match)	Matches completed todos.
void	matchDependencyId(Id todoId, boolean match)	Matches a depednency todo.
void	matchDescendantTodoId(Id todoId, boolean match)	Sets the todo Id for this query to match todos that have the specified todo as a descendant.
void	matchDueDate(DateTime from, DateTime to, boolean match)	Matches todos with dues dates within the given date range inclusive.
void	matchMinimumPriority(Type priorityType, boolean match)	Matches todos of the given priority or greater.
void	matchPriority(Type priorityType, boolean match)	Matches todos of the given priority.
boolean	supportsAncestorTodoQuery()	Tests if a TodoQuery is available.
boolean	supportsChecklistQuery()	Tests if a ChecklistQuery is available.
boolean	supportsDependencyQuery()	Tests if a TodoQuery is available.
boolean	supportsDescendantTodoQuery()	Tests if a TodoQuery 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 OsidContainableQuery

clearSequesteredTerms, matchSequestered

Modifier and Type	Method	Description
void	clearSequesteredTerms()	Clears the sequestered query terms.
void	matchSequestered(boolean match)	Match containables that are sequestered.

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 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 OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

matchComplete

void matchComplete(boolean match)

Matches completed todos.

Parameters:

match - true for to match completed todos, false to match incomplete todos

Compliance:

mandatory - This method must be implemented.

clearCompleteTerms

void clearCompleteTerms()

Clears the complete terms.

Compliance:

mandatory - This method must be implemented.

matchPriority

void matchPriority(Type priorityType,
 boolean match)

Matches todos of the given priority.

Parameters:

priorityType - a priority type

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

Throws:

NullArgumentException - priorityType is null

Compliance:

mandatory - This method must be implemented.

matchAnyPriority

void matchAnyPriority(boolean match)

Matches todos with any priority set.

Parameters:

match - true for to match todos with any priority, false to match todos with no priority

Compliance:

mandatory - This method must be implemented.

clearPriorityTerms

void clearPriorityTerms()

Clears the priority terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumPriority

void matchMinimumPriority(Type priorityType,
 boolean match)

Matches todos of the given priority or greater.

Parameters:

priorityType - a priority type

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

Throws:

NullArgumentException - priorityType is null

Compliance:

mandatory - This method must be implemented.

clearMinimumPriorityTerms

void clearMinimumPriorityTerms()

Clears the minimum priority terms.

Compliance:

mandatory - This method must be implemented.

matchDueDate

void matchDueDate(DateTime from,
 DateTime to,
 boolean match)

Matches todos with dues dates within the given date range inclusive.

Parameters:

from - starting date

to - ending date

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyDueDate

void matchAnyDueDate(boolean match)

Matches todos with any due date.

Parameters:

match - true for to match todos with any due date, false to match todos with no due date

Compliance:

mandatory - This method must be implemented.

clearDueDateTerms

void clearDueDateTerms()

Clears the due date terms.

Compliance:

mandatory - This method must be implemented.

matchDependencyId

void matchDependencyId(Id todoId,
 boolean match)

Matches a depednency todo.

Parameters:

todoId - a todo Id

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

Throws:

NullArgumentException - todoId is null

Compliance:

mandatory - This method must be implemented.

clearDependencyIdTerms

void clearDependencyIdTerms()

Clears the todo Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDependencyQuery

boolean supportsDependencyQuery()

Tests if a TodoQuery is available.

Returns:

true if a todo query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDependencyQuery

TodoQuery getDependencyQuery()

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

Returns:

the checklist query

Throws:

UnimplementedException - supportsDependencyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDependencyQuery()} is {@code true} .

matchAnyDependency

void matchAnyDependency(boolean match)

Matches tdos with any dependencies.

Parameters:

match - true for to matchc todos with any dependency, false to matchtodos with no dependencies

Compliance:

mandatory - This method must be implemented.

clearDependencyTerms

void clearDependencyTerms()

Clears the dependency terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorTodoId

void matchAncestorTodoId(Id todoId,
 boolean match)

Sets the todo Id for this query to match todos that have the specified todo as an ancestor.

Parameters:

todoId - a todo Id

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

Throws:

NullArgumentException - todoId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorTodoIdTerms

void clearAncestorTodoIdTerms()

Clears the ancestor todo Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorTodoQuery

boolean supportsAncestorTodoQuery()

Tests if a TodoQuery is available.

Returns:

true if a todo query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorTodoQuery

TodoQuery getAncestorTodoQuery()

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

Returns:

the todo query

Throws:

UnimplementedException - supportsAncestorTodoQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAncestorTodoQuery()} is {@code true} .

matchAnyAncestorTodo

void matchAnyAncestorTodo(boolean match)

Matches todos that have any ancestor.

Parameters:

match - true to match todos with any ancestor, false to match root todos

Compliance:

mandatory - This method must be implemented.

clearAncestorTodoTerms

void clearAncestorTodoTerms()

Clears the ancestor todo query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantTodoId

void matchDescendantTodoId(Id todoId,
 boolean match)

Sets the todo Id for this query to match todos that have the specified todo as a descendant.

Parameters:

todoId - a todo Id

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

Throws:

NullArgumentException - todoId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantTodoIdTerms

void clearDescendantTodoIdTerms()

Clears the descendant todo Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantTodoQuery

boolean supportsDescendantTodoQuery()

Tests if a TodoQuery is available.

Returns:

true if a todo query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantTodoQuery

TodoQuery getDescendantTodoQuery()

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

Returns:

the todo query

Throws:

UnimplementedException - supportsDescendantTodoQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDescendantTodoQuery()} is {@code true} .

matchAnyDescendantTodo

void matchAnyDescendantTodo(boolean match)

Matches todos that have any descendant.

Parameters:

match - true to match todos with any descendant, false to match leaf todos

Compliance:

mandatory - This method must be implemented.

clearDescendantTodoTerms

void clearDescendantTodoTerms()

Clears the descendant todo query terms.

Compliance:

mandatory - This method must be implemented.

matchChecklistId

void matchChecklistId(Id checklistId,
 boolean match)

Sets the checklist Id for this query to match todos assigned to checklists.

Parameters:

checklistId - a 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 terms.

Compliance:

mandatory - This method must be implemented.

supportsChecklistQuery

boolean supportsChecklistQuery()

Tests if a 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 query. 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 terms.

Compliance:

mandatory - This method must be implemented.

getTodoQueryRecord

TodoQueryRecord getTodoQueryRecord(Type todoRecordType)
                            throws OperationFailedException

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

Parameters:

todoRecordType - a todo record type

Returns:

the todo query record

Throws:

NullArgumentException - todoRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoRecordType) is false

Compliance:

mandatory - This method must be implemented.