org.osid.checklist

Interface TodoQuery

All Superinterfaces:

Extensible, OsidAggregateableQuery, 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

Methods

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

clearSequesteredTerms, matchSequestered

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

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

Method Detail

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 supportsDependencyQuery() is 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 supportsAncestorTodoQuery() is 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 supportsDescendantTodoQuery() is 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 supportsChecklistQuery() is 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.