Interface TodoQueryInspector
- All Superinterfaces:
Extensible, 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
Modifier and TypeMethodDescriptionIdTerm[]Gets the ancestor todoIdquery terms.Gets the ancestor todo query terms.IdTerm[]Gets the checklistIdquery terms.Gets the checklist query terms.Gets the complete terms.IdTerm[]Gets the dependencyIdterms.Gets the dependency terms.IdTerm[]Gets the descendant todoIdquery terms.Gets the descendant todo query terms.Gets the due date terms.TypeTerm[]Gets the minimum priority terms.TypeTerm[]Gets the priority terms.getTodoQueryInspectorRecord(Type todoRecordType) Gets the todo query inspector record corresponding to the givenTodorecordType.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidContainableQueryInspector
getSequesteredTermsModifier and TypeMethodDescriptionGets the sequestered query terms.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidTemporalQueryInspector
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTermsModifier and TypeMethodDescriptionGets the date query terms.Gets the effective query terms.Gets the end date query terms.Gets the start date query terms.
-
Method Details
-
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 dependencyIdterms.- 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 todoIdquery 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 todoIdquery 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 checklistIdquery 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 givenTodorecordType.- Parameters:
todoRecordType- a todo record type- Returns:
- the todo query inspector record
- Throws:
NullArgumentException-todoRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(todoRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-