org.osid.checklist

Interface TodoQueryInspector

All Superinterfaces:

Extensible, OsidAggregateableQueryInspector, OsidBrowsableQueryInspector, OsidContainableQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidTemporalQueryInspector

public interface TodoQueryInspector
extends OsidObjectQueryInspector, OsidContainableQueryInspector, OsidTemporalQueryInspector, OsidFederateableQueryInspector

The todo query inspector for examining todo queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorTodoIdTerms() Gets the ancestor todo Id query terms.
TodoQueryInspector[]	getAncestorTodoTerms() Gets the ancestor todo query terms.
IdTerm[]	getChecklistIdTerms() Gets the checklist Id query terms.
ChecklistQueryInspector[]	getChecklistTerms() Gets the checklist query terms.
BooleanTerm[]	getCompleteTerms() Gets the complete terms.
IdTerm[]	getDependencyIdTerms() Gets the dependency Id terms.
TodoQueryInspector[]	getDependencyTerms() Gets the dependency terms.
IdTerm[]	getDescendantTodoIdTerms() Gets the descendant todo Id query terms.
TodoQueryInspector[]	getDescendantTodoTerms() Gets the descendant todo query terms.
DateTimeRangeTerm[]	getDueDateTerms() Gets the due date terms.
TypeTerm[]	getMinimumPriorityTerms() Gets the minimum priority terms.
TypeTerm[]	getPriorityTerms() Gets the priority terms.
TodoQueryInspectorRecord	getTodoQueryInspectorRecord(Type todoRecordType) Gets the todo query inspector record corresponding to the given Todo record Type.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidContainableQueryInspector

getSequesteredTerms

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getCompleteTerms

BooleanTerm[] getCompleteTerms()

Gets the complete terms.

Returns:

the completed query terms

Compliance:

mandatory - This method must be implemented.

getPriorityTerms

TypeTerm[] getPriorityTerms()

Gets the priority terms.

Returns:

the priority query terms

Compliance:

mandatory - This method must be implemented.

getMinimumPriorityTerms

TypeTerm[] getMinimumPriorityTerms()

Gets the minimum priority terms.

Returns:

the priority query terms

Compliance:

mandatory - This method must be implemented.

getDueDateTerms

DateTimeRangeTerm[] getDueDateTerms()

Gets the due date terms.

Returns:

the date query terms

Compliance:

mandatory - This method must be implemented.

getDependencyIdTerms

IdTerm[] getDependencyIdTerms()

Gets the dependency Id terms.

Returns:

the todo query terms

Compliance:

mandatory - This method must be implemented.

getDependencyTerms

TodoQueryInspector[] getDependencyTerms()

Gets the dependency terms.

Returns:

the todo query terms

Compliance:

mandatory - This method must be implemented.

getAncestorTodoIdTerms

IdTerm[] getAncestorTodoIdTerms()

Gets the ancestor todo Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorTodoTerms

TodoQueryInspector[] getAncestorTodoTerms()

Gets the ancestor todo query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantTodoIdTerms

IdTerm[] getDescendantTodoIdTerms()

Gets the descendant todo Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantTodoTerms

TodoQueryInspector[] getDescendantTodoTerms()

Gets the descendant todo query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getChecklistIdTerms

IdTerm[] getChecklistIdTerms()

Gets the checklist Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getChecklistTerms

ChecklistQueryInspector[] getChecklistTerms()

Gets the checklist query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTodoQueryInspectorRecord

TodoQueryInspectorRecord getTodoQueryInspectorRecord(Type todoRecordType)
                                                     throws OperationFailedException

Gets the todo query inspector record corresponding to the given Todo record Type.

Parameters:

todoRecordType - a todo record type

Returns:

the todo query inspector record

Throws:

NullArgumentException - todoRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoRecordType) is false

Compliance:

mandatory - This method must be implemented.