org.osid.checklist.mason

Interface TodoProducerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface TodoProducerQueryInspector
extends OsidRuleQueryInspector

This is the query inspector for examining todo producer queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getChecklistIdTerms() Gets the checklist Id query terms.
ChecklistQueryInspector[]	getChecklistTerms() Gets the checklist query terms.
BooleanTerm[]	getCreationRuleTerms() Gets the creationquery terms.
IdTerm[]	getCyclicEventIdTerms() Gets the cyclic event Id query terms.
CyclicEventQueryInspector[]	getCyclicEventTerms() Gets the cyclic event query terms.
IdTerm[]	getProducedTodoIdTerms() Gets the produced Id query terms.
TodoQueryInspector[]	getProducedTodoTerms() Gets the produced query terms.
IdTerm[]	getStockIdTerms() Gets the stock Id query terms.
CardinalRangeTerm[]	getStockLevelTerms() Gets the stock level query terms.
StockQueryInspector[]	getStockTerms() Gets the stock query terms.
TodoProducerQueryInspectorRecord	getTodoProducerQueryInspectorRecord(Type todoProducerRecordType) Gets the todo producer query inspector record corresponding to the given TodoProducer record Type.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getCreationRuleTerms

BooleanTerm[] getCreationRuleTerms()

Gets the creationquery terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCyclicEventIdTerms

IdTerm[] getCyclicEventIdTerms()

Gets the cyclic event Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCyclicEventTerms

CyclicEventQueryInspector[] getCyclicEventTerms()

Gets the cyclic event query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStockIdTerms

IdTerm[] getStockIdTerms()

Gets the stock Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStockTerms

StockQueryInspector[] getStockTerms()

Gets the stock query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStockLevelTerms

CardinalRangeTerm[] getStockLevelTerms()

Gets the stock level query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProducedTodoIdTerms

IdTerm[] getProducedTodoIdTerms()

Gets the produced Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProducedTodoTerms

TodoQueryInspector[] getProducedTodoTerms()

Gets the produced 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.

getTodoProducerQueryInspectorRecord

TodoProducerQueryInspectorRecord getTodoProducerQueryInspectorRecord(Type todoProducerRecordType)
                                                                     throws OperationFailedException

Gets the todo producer query inspector record corresponding to the given TodoProducer record Type.

Parameters:

todoProducerRecordType - a todo producer record type

Returns:

the todo producer query inspector record

Throws:

NullArgumentException - todoProducerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoProducerRecordType) is false

Compliance:

mandatory - This method must be implemented.