org.osid.checklist

Interface ChecklistQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

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.

Method Summary

Methods

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.

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.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchTodoId

void matchTodoId(Id todoId,
               boolean match)

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

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.

clearTodoIdTerms

void clearTodoIdTerms()

Clears the todo Id terms.

Compliance:

mandatory - This method must be implemented.

supportsTodoQuery

boolean supportsTodoQuery()

Tests if a todo query is available.

Returns:

true if a todo query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTodoQuery

TodoQuery getTodoQuery()

Gets the query for a todo.

Returns:

the todo query

Throws:

UnimplementedException - supportsTodoQuery() is false

Compliance:

optional - This method must be implemented if supportsTodoQuery() is true.

matchAnyTodo

void matchAnyTodo(boolean match)

Matches checklists with any todo.

Parameters:

match - true to match checklists with any todo, false to match checklists with no todos

Compliance:

mandatory - This method must be implemented.

clearTodoTerms

void clearTodoTerms()

Clears the todo terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorChecklistId

void matchAncestorChecklistId(Id checklistId,
                            boolean match)

Sets the checklist Id for this query to match checklists that have the specified checklist as an ancestor.

Parameters:

checklistId - a checklist Id

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

Throws:

NullArgumentException - checklistId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorChecklistIdTerms

void clearAncestorChecklistIdTerms()

Clears the ancestor checklist Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorChecklistQuery

boolean supportsAncestorChecklistQuery()

Tests if a ChecklistQuery is available.

Returns:

true if a checklist query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorChecklistQuery

ChecklistQuery getAncestorChecklistQuery()

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

Returns:

the checklist query

Throws:

UnimplementedException - supportsAncestorChecklistQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorChecklistQuery() is true.

matchAnyAncestorChecklist

void matchAnyAncestorChecklist(boolean match)

Matches checklists with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorChecklistTerms

void clearAncestorChecklistTerms()

Clears the ancestor checklist terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantChecklistId

void matchDescendantChecklistId(Id checklistId,
                              boolean match)

Sets the checklist Id for this query to match checklists that have the specified checklist as a descendant.

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.

clearDescendantChecklistIdTerms

void clearDescendantChecklistIdTerms()

Clears the descendant checklist Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantChecklistQuery

boolean supportsDescendantChecklistQuery()

Tests if a ChecklistQuery is available.

Returns:

true if a checklist query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantChecklistQuery

ChecklistQuery getDescendantChecklistQuery()

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

Returns:

the checklist query

Throws:

UnimplementedException - supportsDescendantChecklistQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantChecklistQuery() is true.

matchAnyDescendantChecklist

void matchAnyDescendantChecklist(boolean match)

Matches checklists with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantChecklistTerms

void clearDescendantChecklistTerms()

Clears the descendant checklist terms.

Compliance:

mandatory - This method must be implemented.

getChecklistQueryRecord

ChecklistQueryRecord getChecklistQueryRecord(Type checklistRecordType)
                                             throws OperationFailedException

Gets the checklist query record corresponding to the given Checklist record Type. Multiple record retrievals produce a nested boolean OR term.

Parameters:

checklistRecordType - a checklist record type

Returns:

the checklist query record

Throws:

NullArgumentException - checklistRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(checklistRecordType) is false

Compliance:

mandatory - This method must be implemented.