org.osid.checklist

Interface ChecklistQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface ChecklistQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining checklist queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorChecklistIdTerms() Gets the ancestor checklist Id terms.
ChecklistQueryInspector[]	getAncestorChecklistTerms() Gets the ancestor checklist terms.
ChecklistQueryInspectorRecord	getChecklistQueryInspectorRecord(Type checklistRecordType) Gets the checklist query inspector record corresponding to the given Checklist record Type.
IdTerm[]	getDescendantChecklistIdTerms() Gets the descendant checklist Id terms.
ChecklistQueryInspector[]	getDescendantChecklistTerms() Gets the descendant checklist terms.
IdTerm[]	getTodoIdTerms() Gets the todo Id terms.
TodoQueryInspector[]	getTodoTerms() Gets the todo terms.

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

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getTodoIdTerms

IdTerm[] getTodoIdTerms()

Gets the todo Id terms.

Returns:

the todo Id terms

Compliance:

mandatory - This method must be implemented.

getTodoTerms

TodoQueryInspector[] getTodoTerms()

Gets the todo terms.

Returns:

the todo terms

Compliance:

mandatory - This method must be implemented.

getAncestorChecklistIdTerms

IdTerm[] getAncestorChecklistIdTerms()

Gets the ancestor checklist Id terms.

Returns:

the ancestor checklist Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorChecklistTerms

ChecklistQueryInspector[] getAncestorChecklistTerms()

Gets the ancestor checklist terms.

Returns:

the ancestor checklist terms

Compliance:

mandatory - This method must be implemented.

getDescendantChecklistIdTerms

IdTerm[] getDescendantChecklistIdTerms()

Gets the descendant checklist Id terms.

Returns:

the descendant checklist Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantChecklistTerms

ChecklistQueryInspector[] getDescendantChecklistTerms()

Gets the descendant checklist terms.

Returns:

the descendant checklist terms

Compliance:

mandatory - This method must be implemented.

getChecklistQueryInspectorRecord

ChecklistQueryInspectorRecord getChecklistQueryInspectorRecord(Type checklistRecordType)
                                                               throws OperationFailedException

Gets the checklist query inspector record corresponding to the given Checklist record Type.

Parameters:

checklistRecordType - a checklist record type

Returns:

the checklist query inspector record

Throws:

NullArgumentException - checklistRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(checklistRecordType) is false

Compliance:

mandatory - This method must be implemented.