OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.ProcedureQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching procedures. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchLearningObjectiveId
Description

Sets the objective Id for this query.

Parametersosid.id.IdobjectiveIdthe asset Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveId is null
CompliancemandatoryThis method must be implemented.
MethodclearLearningObjectiveIdTerms
Description

Clears the objective Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLearningObjectiveQuery
Description

Tests if an ObjectiveQuery is available.

Returnboolean true if an objective query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveQuery
Description

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

Returnosid.learning.ObjectiveQuerythe objective query
ErrorsUNIMPLEMENTED supportsLearningObjectiveQuery() is false
ComplianceoptionalThis method must be implemented if supportsLearningObjectiveQuery() is true.
MethodmatchAnyLearningObjective
Description

Matches directions with any objective.

Parametersbooleanmatch true to match directions with any objective, false to match directions with no objectives
CompliancemandatoryThis method must be implemented.
MethodclearLearningObjectiveTerms
Description

Clears the objective query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCookbookId
Description

Sets the award Id for this query to match procedures assigned to cook books.

Parametersosid.id.IdcookbookIda cook book Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT cookbookId is null
CompliancemandatoryThis method must be implemented.
MethodclearCookbookIdTerms
Description

Clears the cook book Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCookbookQuery
Description

Tests if an CookbookQuery is available.

Returnboolean true if a cook book query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCookbookQuery
Description

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

Returnosid.recipe.CookbookQuerythe cook book query
ErrorsUNIMPLEMENTED supportsCookbookQuery() is false
ComplianceoptionalThis method must be implemented if supportsCookbookQuery() is true.
MethodclearCookbookTerms
Description

Clears the cook book terms.

CompliancemandatoryThis method must be implemented.
MethodgetProcedureQueryRecord
Description

Gets the procedure query record corresponding to the given Procedure record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeprocedureRecordTypea procedure record type
Returnosid.recipe.records.ProcedureQueryRecordthe procedure query record
ErrorsNULL_ARGUMENT procedureRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(procedureRecordType) is false
CompliancemandatoryThis method must be implemented.