public interface ChecklistQuery extends OsidCatalogQuery
This is the query for searching for checklists. Each method specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorChecklistIdTerms()
Clears the ancestor checklist
Id terms. |
void |
clearAncestorChecklistTerms()
Clears the ancestor checklist terms.
|
void |
clearDescendantChecklistIdTerms()
Clears the descendant checklist
Id terms. |
void |
clearDescendantChecklistTerms()
Clears the descendant checklist terms.
|
void |
clearTodoIdTerms()
Clears the todo
Id terms. |
void |
clearTodoTerms()
Clears the todo terms.
|
ChecklistQuery |
getAncestorChecklistQuery()
Gets the query for a checklist.
|
ChecklistQueryRecord |
getChecklistQueryRecord(Type checklistRecordType)
Gets the checklist query record corresponding to the given
Checklist record Type. |
ChecklistQuery |
getDescendantChecklistQuery()
Gets the query for a checklist.
|
TodoQuery |
getTodoQuery()
Gets the query for a todo.
|
void |
matchAncestorChecklistId(Id checklistId,
boolean match)
Sets the checklist
Id for this query to match
checklists that have the specified checklist as an ancestor. |
void |
matchAnyAncestorChecklist(boolean match)
Matches checklists with any ancestor.
|
void |
matchAnyDescendantChecklist(boolean match)
Matches checklists with any descendant.
|
void |
matchAnyTodo(boolean match)
Matches checklists with any todo.
|
void |
matchDescendantChecklistId(Id checklistId,
boolean match)
Sets the checklist
Id for this query to match
checklists that have the specified checklist as a descendant. |
void |
matchTodoId(Id todoId,
boolean match)
Sets the todo
Id for this query to match todos assigned
to checklists. |
boolean |
supportsAncestorChecklistQuery()
Tests if a
ChecklistQuery is available. |
boolean |
supportsDescendantChecklistQuery()
Tests if a
ChecklistQuery is available. |
boolean |
supportsTodoQuery()
Tests if a todo query is available.
|
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchTodoId(Id todoId, boolean match)
Id
for this query to match todos assigned
to checklists.todoId
- a todo Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- todoId
is
null
mandatory
- This method must be implemented. void clearTodoIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsTodoQuery()
true
if a todo query is available, false
otherwisemandatory
- This method must be implemented. TodoQuery getTodoQuery()
UnimplementedException
- supportsTodoQuery()
is false
optional
- This method must be implemented if
supportsTodoQuery()
is true.
void matchAnyTodo(boolean match)
match
- true
to match checklists with any todo,
false
to match checklists with no todosmandatory
- This method must be implemented. void clearTodoTerms()
mandatory
- This method must be implemented. void matchAncestorChecklistId(Id checklistId, boolean match)
Id
for this query to match
checklists that have the specified checklist as an ancestor.checklistId
- a checklist Id
match
- true
for a positive match, a false
for a negative matchNullArgumentException
- checklistId
is
null
mandatory
- This method must be implemented. void clearAncestorChecklistIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorChecklistQuery()
ChecklistQuery
is available. true
if a checklist query is available,
false
otherwisemandatory
- This method must be implemented. ChecklistQuery getAncestorChecklistQuery()
OR
term.UnimplementedException
-
supportsAncestorChecklistQuery()
is false
optional
- This method must be implemented if
supportsAncestorChecklistQuery()
is true.
void matchAnyAncestorChecklist(boolean match)
match
- true
to match checklists with any
ancestor, false
to match root checklistsmandatory
- This method must be implemented. void clearAncestorChecklistTerms()
mandatory
- This method must be implemented. void matchDescendantChecklistId(Id checklistId, boolean match)
Id
for this query to match
checklists that have the specified checklist as a descendant.checklistId
- a checklist Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- checklistId
is
null
mandatory
- This method must be implemented. void clearDescendantChecklistIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantChecklistQuery()
ChecklistQuery
is available. true
if a checklist query is available,
false
otherwisemandatory
- This method must be implemented. ChecklistQuery getDescendantChecklistQuery()
OR
term.UnimplementedException
-
supportsDescendantChecklistQuery()
is false
optional
- This method must be implemented if
supportsDescendantChecklistQuery()
is true.
void matchAnyDescendantChecklist(boolean match)
match
- true
to match checklists with any
descendant, false
to match leaf checklistsmandatory
- This method must be implemented. void clearDescendantChecklistTerms()
mandatory
- This method must be implemented. ChecklistQueryRecord getChecklistQueryRecord(Type checklistRecordType) throws OperationFailedException
Checklist
record Type.
Multiple record
retrievals produce a nested boolean OR
term.checklistRecordType
- a checklist record typeNullArgumentException
- checklistRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(checklistRecordType)
is false
mandatory
- This method must be implemented.