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.
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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchLearningObjectiveId(Id objectiveId, boolean match)
Id
for this query.objectiveId
- the asset Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- objectiveId
is
null
mandatory
- This method must be implemented. void clearLearningObjectiveIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsLearningObjectiveQuery()
ObjectiveQuery
is available. true
if an objective query is available,
false
otherwisemandatory
- This method must be implemented. ObjectiveQuery getLearningObjectiveQuery()
OR
term.UnimplementedException
-
supportsLearningObjectiveQuery()
is false
optional
- This method must be implemented if
supportsLearningObjectiveQuery()
is true.
void matchAnyLearningObjective(boolean match)
match
- true
to match directions with any
objective, false
to match directions with no
objectivesmandatory
- This method must be implemented. void clearLearningObjectiveTerms()
mandatory
- This method must be implemented. void matchCookbookId(Id cookbookId, boolean match)
Id
for this query to match procedures
assigned to cook books.cookbookId
- a cook book Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- cookbookId
is
null
mandatory
- This method must be implemented. void clearCookbookIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCookbookQuery()
CookbookQuery
is available. true
if a cook book query is available,
false
otherwisemandatory
- This method must be implemented. CookbookQuery getCookbookQuery()
OR
term.UnimplementedException
- supportsCookbookQuery()
is false
optional
- This method must be implemented if
supportsCookbookQuery()
is true.
void clearCookbookTerms()
mandatory
- This method must be implemented. ProcedureQueryRecord getProcedureQueryRecord(Type procedureRecordType) throws OperationFailedException
Procedure
record Type.
Multiple record
retrievals produce a nested OR
term.procedureRecordType
- a procedure record typeNullArgumentException
- procedureRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(procedureRecordType)
is false
mandatory
- This method must be implemented.