org.osid.recipe

Interface ProcedureQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface ProcedureQueryInspector
extends OsidObjectQueryInspector

The inspector for examining procedure queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCookbookIdTerms() Gets the cook book Id terms.
CookbookQueryInspector[]	getCookbookTerms() Gets the cook book terms.
IdTerm[]	getLearningObjectiveIdTerms() Gets the objective Id terms.
ObjectiveQueryInspector[]	getLearningObjectiveTerms() Gets the objective terms.
ProcedureQueryInspectorRecord	getProcedureQueryInspectorRecord(Type procedureRecordType) Gets the procedure query inspector record corresponding to the given Procedure record Type.

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

Method Detail

getLearningObjectiveIdTerms

IdTerm[] getLearningObjectiveIdTerms()

Gets the objective Id terms.

Returns:

the objective Id terms

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveTerms

ObjectiveQueryInspector[] getLearningObjectiveTerms()

Gets the objective terms.

Returns:

the objective terms

Compliance:

mandatory - This method must be implemented.

getCookbookIdTerms

IdTerm[] getCookbookIdTerms()

Gets the cook book Id terms.

Returns:

the cook book Id terms

Compliance:

mandatory - This method must be implemented.

getCookbookTerms

CookbookQueryInspector[] getCookbookTerms()

Gets the cook book terms.

Returns:

the cook book terms

Compliance:

mandatory - This method must be implemented.

getProcedureQueryInspectorRecord

ProcedureQueryInspectorRecord getProcedureQueryInspectorRecord(Type procedureRecordType)
                                                               throws OperationFailedException

Gets the procedure query inspector record corresponding to the given Procedure record Type.

Parameters:

procedureRecordType - a procedure record type

Returns:

the procedure query inspector record

Throws:

NullArgumentException - procedureRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(procedureRecordType) is false

Compliance:

mandatory - This method must be implemented.