public interface RequisiteQuery extends OsidRuleQuery, OsidEnablerQuery, OsidContainableQuery
This is the query for searching requisites. Each method match specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAssessmentIdTerms()
Clears the assessment
Id terms. |
void |
clearAssessmentTerms()
Clears the assessment terms.
|
void |
clearAwardIdTerms()
Clears the award
Id terms. |
void |
clearAwardTerms()
Clears the award terms.
|
void |
clearContainingRequisiteIdTerms()
Clears the containing requisite
Id terms. |
void |
clearContainingRequisiteTerms()
Clears the containing requisite terms.
|
void |
clearCourseCatalogIdTerms()
Clears the course catalog
Id terms. |
void |
clearCourseCatalogTerms()
Clears the course catalog terms.
|
void |
clearCourseIdTerms()
Clears the course
Id terms. |
void |
clearCourseTerms()
Clears the course terms.
|
void |
clearCredentialIdTerms()
Clears the credential
Id terms. |
void |
clearCredentialTerms()
Clears the credential terms.
|
void |
clearLearningObjectiveIdTerms()
Clears the learning objective
Id terms. |
void |
clearLearningObjectiveTerms()
Clears the learning objective terms.
|
void |
clearProgramIdTerms()
Clears the program
Id terms. |
void |
clearProgramTerms()
Clears the program terms.
|
void |
clearRequisiteOptionIdTerms()
Clears the requisite
Id terms. |
void |
clearRequisiteOptionTerms()
Clears the requisite option terms.
|
AssessmentQuery |
getAssessmentQuery()
Gets the query for a assessment requirement.
|
AwardQuery |
getAwardQuery()
Gets the query for a award requirement.
|
RequisiteQuery |
getContainingRequisiteQuery()
Gets the query for a containing requisite.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog.
|
CourseQuery |
getCourseQuery()
Gets the query for a course requirement.
|
CredentialQuery |
getCredentialQuery()
Gets the query for a credential requirement.
|
ObjectiveQuery |
getLearningObjectiveQuery()
Gets the query for a learning objective requirement.
|
ProgramQuery |
getProgramQuery()
Gets the query for a program requirement.
|
RequisiteQuery |
getRequisiteOptionQuery()
Gets the query for a requisite option.
|
RequisiteQueryRecord |
getRequisiteQueryRecord(Type requisiteRecordType)
Gets the requisite query record corresponding to the given
Requisite record Type. |
void |
matchAnyAssessment(boolean match)
Matches requisites that have any assessment requirement.
|
void |
matchAnyAward(boolean match)
Matches requisites that have any award requirement.
|
void |
matchAnyContainingRequisite(boolean match)
Matches requisites with any ancestor requisite.
|
void |
matchAnyCourse(boolean match)
Matches requisites that have any course requirement.
|
void |
matchAnyCredential(boolean match)
Matches requisites that have any credential requirement.
|
void |
matchAnyLearningObjective(boolean match)
Matches requisites that have any learning objective requirement.
|
void |
matchAnyProgram(boolean match)
Matches requisites that have any program requirement.
|
void |
matchAnyRequisiteOption(boolean match)
Matches requisites that have any requisite option.
|
void |
matchAssessmentId(Id assessmentId,
boolean match)
Sets the assessment
Id for this query to match
requisites that have a requirement for the given assessment. |
void |
matchAwardId(Id awardId,
boolean match)
Sets the award
Id for this query to match requisites
that have a requirement for the given award. |
void |
matchContainingRequisiteId(Id requisiteId,
boolean match)
Sets the requisite
Id for this query to match
requisites that have the specified requisite as an ancestor. |
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the course catalog
Id for this query to match
requisites assigned to course catalogs. |
void |
matchCourseId(Id courseId,
boolean match)
Sets the course
Id for this query to match requisites
that have a requirement for the given course. |
void |
matchCredentialId(Id credentialId,
boolean match)
Sets the credential
Id for this query to match
requisites that have a requirement for the given credential. |
void |
matchLearningObjectiveId(Id objectiveId,
boolean match)
Sets the learning objective
Id for this query to match
requisites that have a requirement for the given learning objective. |
void |
matchProgramId(Id programId,
boolean match)
Sets the program
Id for this query to match requisites
that have a requirement for the given program. |
void |
matchRequisiteOptionId(Id requisiteId,
boolean match)
Sets the requisite
Id for this query to match
requisites that a requisite option. |
boolean |
supportsAssessmentQuery()
Tests if an
AssessmentQuery is available. |
boolean |
supportsAwardQuery()
Tests if an
AwardQuery is available. |
boolean |
supportsContainingRequisiteQuery()
Tests if a containing requisite query is available.
|
boolean |
supportsCourseCatalogQuery()
Tests if a
CourseCatalogQuery is available. |
boolean |
supportsCourseQuery()
Tests if a
CourseQuery is available. |
boolean |
supportsCredentialQuery()
Tests if a
CredentialQuery is available. |
boolean |
supportsLearningObjectiveQuery()
Tests if a
LearningObjectiveQuery is available. |
boolean |
supportsProgramQuery()
Tests if a
ProgramQuery is available. |
boolean |
supportsRequisiteOptionQuery()
Tests if a
RequisiteQuery is available. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
clearSequesteredTerms, matchSequestered
void matchRequisiteOptionId(Id requisiteId, boolean match)
Id
for this query to match
requisites that a requisite option.requisiteId
- a requisite Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- requisiteId
is
null
mandatory
- This method must be implemented. void clearRequisiteOptionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRequisiteOptionQuery()
RequisiteQuery
is available. true
if a requisite query is available,
false
otherwisemandatory
- This method must be implemented. RequisiteQuery getRequisiteOptionQuery()
OR
term.UnimplementedException
-
supportsRequisiteOptionQuery()
is false
optional
- This method must be implemented if
supportsRequisiteOptionQuery()
is true.
void matchAnyRequisiteOption(boolean match)
match
- true
to match requisites with any
requisite option, false
to match requisites
with no requisite optionsmandatory
- This method must be implemented. void clearRequisiteOptionTerms()
mandatory
- This method must be implemented. void matchCourseId(Id courseId, boolean match)
Id
for this query to match requisites
that have a requirement for the given course.courseId
- a course Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- courseId
is
null
mandatory
- This method must be implemented. void clearCourseIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseQuery()
CourseQuery
is available. true
if a course query is available,
false
otherwisemandatory
- This method must be implemented. CourseQuery getCourseQuery()
OR
term.UnimplementedException
- supportsCourseQuery()
is false
optional
- This method must be implemented if
supportsCourseQuery()
is true.
void matchAnyCourse(boolean match)
match
- true
to match requisites with any course
requirement, false
to match requisites with no
course requirementsmandatory
- This method must be implemented. void clearCourseTerms()
mandatory
- This method must be implemented. void matchProgramId(Id programId, boolean match)
Id
for this query to match requisites
that have a requirement for the given program.programId
- a program Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- programId
is
null
mandatory
- This method must be implemented. void clearProgramIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsProgramQuery()
ProgramQuery
is available. true
if a program query is available,
false
otherwisemandatory
- This method must be implemented. ProgramQuery getProgramQuery()
OR
term.UnimplementedException
- supportsProgramQuery()
is false
optional
- This method must be implemented if
supportsProgramQuery()
is true.
void matchAnyProgram(boolean match)
match
- true
to match requisites with any program
requirement, false
to match requisites with no
program requirementsmandatory
- This method must be implemented. void clearProgramTerms()
mandatory
- This method must be implemented. void matchCredentialId(Id credentialId, boolean match)
Id
for this query to match
requisites that have a requirement for the given credential.credentialId
- a credential Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- credentialId
is
null
mandatory
- This method must be implemented. void clearCredentialIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCredentialQuery()
CredentialQuery
is available. true
if a credential query is available,
false
otherwisemandatory
- This method must be implemented. CredentialQuery getCredentialQuery()
OR
term.UnimplementedException
-
supportsCredentialQuery()
is false
optional
- This method must be implemented if
supportsCredentialQuery()
is true.
void matchAnyCredential(boolean match)
match
- true
to match requisites with any
credential requirement, false
to match
requisites with no credential requirementsmandatory
- This method must be implemented. void clearCredentialTerms()
mandatory
- This method must be implemented. void matchLearningObjectiveId(Id objectiveId, boolean match)
Id
for this query to match
requisites that have a requirement for the given learning objective.objectiveId
- a learning objective Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- objectiveId
is
null
mandatory
- This method must be implemented. void clearLearningObjectiveIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsLearningObjectiveQuery()
LearningObjectiveQuery
is available. true
if a learning 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 requisites with any
learning objective requirement, false
to match
requisites with no learning objective requirementsmandatory
- This method must be implemented. void clearLearningObjectiveTerms()
mandatory
- This method must be implemented. void matchAssessmentId(Id assessmentId, boolean match)
Id
for this query to match
requisites that have a requirement for the given assessment.assessmentId
- an assessment Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- assessmentId
is
null
mandatory
- This method must be implemented. void clearAssessmentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAssessmentQuery()
AssessmentQuery
is available. true
if an assessment query is available,
false
otherwisemandatory
- This method must be implemented. AssessmentQuery getAssessmentQuery()
OR
term.UnimplementedException
-
supportsAssessmentQuery()
is false
optional
- This method must be implemented if
supportsAssessmentQuery()
is true.
void matchAnyAssessment(boolean match)
match
- true
to match requisites with any
assessment requirement, false
to match
requisites with no assessment requirementsmandatory
- This method must be implemented. void clearAssessmentTerms()
mandatory
- This method must be implemented. void matchAwardId(Id awardId, boolean match)
Id
for this query to match requisites
that have a requirement for the given award.awardId
- an award Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- awardId
is
null
mandatory
- This method must be implemented. void clearAwardIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAwardQuery()
AwardQuery
is available. true
if an award query is available,
false
otherwisemandatory
- This method must be implemented. AwardQuery getAwardQuery()
OR
term.UnimplementedException
- supportsAwardQuery()
is false
optional
- This method must be implemented if
supportsAwardQuery()
is true.
void matchAnyAward(boolean match)
match
- true
to match requisites with any award
requirement, false
to match requisites with no
award requirementsmandatory
- This method must be implemented. void clearAwardTerms()
mandatory
- This method must be implemented. void matchContainingRequisiteId(Id requisiteId, boolean match)
Id
for this query to match
requisites that have the specified requisite as an ancestor.requisiteId
- a requisite Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- requisiteId
is
null
mandatory
- This method must be implemented. void clearContainingRequisiteIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsContainingRequisiteQuery()
true
if a containing requisite query is
available, false
otherwisemandatory
- This method must be implemented. RequisiteQuery getContainingRequisiteQuery()
UnimplementedException
-
supportsContainingRequisiteQuery()
is false
optional
- This method must be implemented if
supportsContainingRequisiteQuery()
is true.
void matchAnyContainingRequisite(boolean match)
match
- true
to match requisites with any
ancestor requisite, false
to match requisites
with no ancestor requisitesmandatory
- This method must be implemented. void clearContainingRequisiteTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match
requisites assigned to course catalogs.courseCatalogId
- the course catalog Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- courseCatalogId
is null
mandatory
- This method must be implemented. void clearCourseCatalogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseCatalogQuery()
CourseCatalogQuery
is available. true
if a course catalog query is available,
false
otherwisemandatory
- This method must be implemented. CourseCatalogQuery getCourseCatalogQuery()
OR
term.UnimplementedException
-
supportsCourseCatalogQuery()
is false
optional
- This method must be implemented if
supportsCourseCatalogQuery()
is true.
void clearCourseCatalogTerms()
mandatory
- This method must be implemented. RequisiteQueryRecord getRequisiteQueryRecord(Type requisiteRecordType) throws OperationFailedException
Requisite
record Type.
Multiple record
retrievals produce a nested OR
term.requisiteRecordType
- a requisites record typeNullArgumentException
- requisiteRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(requisiteRecordType)
is false
mandatory
- This method must be implemented.