org.osid.recipe

Interface ProcedureQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface ProcedureQuery
extends OsidObjectQuery

This is the query for searching procedures. 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	clearCookbookIdTerms() Clears the cook book Id terms.
void	clearCookbookTerms() Clears the cook book terms.
void	clearLearningObjectiveIdTerms() Clears the objective Id query terms.
void	clearLearningObjectiveTerms() Clears the objective query terms.
CookbookQuery	getCookbookQuery() Gets the query for a cook book query.
ObjectiveQuery	getLearningObjectiveQuery() Gets the query for an objective.
ProcedureQueryRecord	getProcedureQueryRecord(Type procedureRecordType) Gets the procedure query record corresponding to the given Procedure record Type.
void	matchAnyLearningObjective(boolean match) Matches directions with any objective.
void	matchCookbookId(Id cookbookId, boolean match) Sets the award Id for this query to match procedures assigned to cook books.
void	matchLearningObjectiveId(Id objectiveId, boolean match) Sets the objective Id for this query.
boolean	supportsCookbookQuery() Tests if an CookbookQuery is available.
boolean	supportsLearningObjectiveQuery() Tests if an ObjectiveQuery 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

Method Detail

matchLearningObjectiveId

void matchLearningObjectiveId(Id objectiveId,
                            boolean match)

Sets the objective Id for this query.

Parameters:

objectiveId - the asset Id

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

Throws:

NullArgumentException - objectiveId is null

Compliance:

mandatory - This method must be implemented.

clearLearningObjectiveIdTerms

void clearLearningObjectiveIdTerms()

Clears the objective Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsLearningObjectiveQuery

boolean supportsLearningObjectiveQuery()

Tests if an ObjectiveQuery is available.

Returns:

true if an objective query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveQuery

ObjectiveQuery getLearningObjectiveQuery()

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

Returns:

the objective query

Throws:

UnimplementedException - supportsLearningObjectiveQuery() is false

Compliance:

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

matchAnyLearningObjective

void matchAnyLearningObjective(boolean match)

Matches directions with any objective.

Parameters:

match - true to match directions with any objective, false to match directions with no objectives

Compliance:

mandatory - This method must be implemented.

clearLearningObjectiveTerms

void clearLearningObjectiveTerms()

Clears the objective query terms.

Compliance:

mandatory - This method must be implemented.

matchCookbookId

void matchCookbookId(Id cookbookId,
                   boolean match)

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

Parameters:

cookbookId - a cook book Id

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

Throws:

NullArgumentException - cookbookId is null

Compliance:

mandatory - This method must be implemented.

clearCookbookIdTerms

void clearCookbookIdTerms()

Clears the cook book Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCookbookQuery

boolean supportsCookbookQuery()

Tests if an CookbookQuery is available.

Returns:

true if a cook book query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCookbookQuery

CookbookQuery getCookbookQuery()

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

Returns:

the cook book query

Throws:

UnimplementedException - supportsCookbookQuery() is false

Compliance:

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

clearCookbookTerms

void clearCookbookTerms()

Clears the cook book terms.

Compliance:

mandatory - This method must be implemented.

getProcedureQueryRecord

ProcedureQueryRecord getProcedureQueryRecord(Type procedureRecordType)
                                             throws OperationFailedException

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

Parameters:

procedureRecordType - a procedure record type

Returns:

the procedure query record

Throws:

NullArgumentException - procedureRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(procedureRecordType) is false

Compliance:

mandatory - This method must be implemented.