public interface DocetQuery extends OsidRelationshipQuery
This is the query for searching for docets. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearActivityUnitIdTerms()
Clears the activity unit
Id terms. |
void |
clearActivityUnitTerms()
Clears the activity unit terms.
|
void |
clearAssessmentIdTerms()
Clears the assessment
Id terms. |
void |
clearAssessmentTerms()
Clears the assessment terms.
|
void |
clearAssetIdTerms()
Clears the asset
Id terms. |
void |
clearAssetTerms()
Clears the asset terms.
|
void |
clearCourseCatalogIdTerms()
Clears the course catalog
Id terms. |
void |
clearCourseCatalogTerms()
Clears the course catalog terms.
|
void |
clearDurationTerms()
Clears the duration terms.
|
void |
clearInClassTerms()
Clears the in class terms.
|
void |
clearLearningObjectiveIdTerms()
Clears the objective
Id terms. |
void |
clearLearningObjectiveTerms()
Clears the objective terms.
|
void |
clearModuleIdTerms()
Clears the module
Id terms. |
void |
clearModuleTerms()
Clears the module terms.
|
ActivityUnitQuery |
getActivityUnitQuery()
Gets the query for an activity unit.
|
AssessmentQuery |
getAssessmentQuery()
Gets the query for an assessment.
|
AssetQuery |
getAssetQuery()
Gets the query for an asset.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog query.
|
DocetQueryRecord |
getDocetQueryRecord(Type docetRecordType)
Gets the docet query record corresponding to the given
Docet
record Type. |
ObjectiveQuery |
getLearningObjectiveQuery()
Gets the query for an objective.
|
ModuleQuery |
getModuleQuery()
Gets the query for a module.
|
void |
matchActivityUnitId(Id activityUnitId,
boolean match)
Sets the activity unit
Id for this query. |
void |
matchAnyAssessment(boolean match)
Matches an objective that has any assessment assigned.
|
void |
matchAnyAsset(boolean match)
Matches a docet that has any asset assigned.
|
void |
matchAnyDuration(boolean match)
Matches a docet that has any duration assigned.
|
void |
matchAnyLearningObjective(boolean match)
Matches a docet that has any objective assigned.
|
void |
matchAssessmentId(Id assessmentId,
boolean match)
Sets the assessment
Id for this query. |
void |
matchAssetId(Id assetId,
boolean match)
Sets the asset
Id for this query. |
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the docet
Id for this query to match syllabi
assigned to course catalogs. |
void |
matchDuration(Duration from,
Duration to,
boolean match)
Matches durations between the given durations inclusive.
|
void |
matchInClass(boolean match)
Matches docets that occur in a class.
|
void |
matchLearningObjectiveId(Id objectiveId,
boolean match)
Sets the objective
Id for this query. |
void |
matchModuleId(Id moduleId,
boolean match)
Sets the module
Id for this query. |
boolean |
supportsActivityUnitQuery()
Tests if an activity unit query is available.
|
boolean |
supportsAssessmentQuery()
Tests if an
AssessmentQuery is available. |
boolean |
supportsAssetQuery()
Tests if an
AssetQuery is available. |
boolean |
supportsCourseCatalogQuery()
Tests if an
CourseCatalogQuery is available. |
boolean |
supportsLearningObjectiveQuery()
Tests if an
ObjectiveQuery is available for querying
objectives. |
boolean |
supportsModuleQuery()
Tests if a module query is available.
|
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchModuleId(Id moduleId, boolean match)
Id
for this query.moduleId
- a module Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- moduleId
is
null
mandatory
- This method must be implemented. void clearModuleIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsModuleQuery()
true
if a module query is available,
false
otherwisemandatory
- This method must be implemented. ModuleQuery getModuleQuery()
UnimplementedException
- supportsModuleQuery()
is false
optional
- This method must be implemented if
supportsModuleQuery()
is true.
void clearModuleTerms()
mandatory
- This method must be implemented. void matchActivityUnitId(Id activityUnitId, boolean match)
Id
for this query.activityUnitId
- an activity unit Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- activityUnitId
is null
mandatory
- This method must be implemented. void clearActivityUnitIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsActivityUnitQuery()
true
if an activity unit query is available,
false
otherwisemandatory
- This method must be implemented. ActivityUnitQuery getActivityUnitQuery()
UnimplementedException
-
supportsActivityUnitQuery()
is false
optional
- This method must be implemented if
supportsActivityUnitQuery()
is true.
void clearActivityUnitTerms()
mandatory
- This method must be implemented. void matchLearningObjectiveId(Id objectiveId, boolean match)
Id
for this query.objectiveId
- an objective Id
match
- true
for 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()
ObjectiveQuery
is available for querying
objectives. true
if an robjective 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 docets with any objective,
false
to match docets with no objectivemandatory
- This method must be implemented. void clearLearningObjectiveTerms()
mandatory
- This method must be implemented. void matchInClass(boolean match)
match
- true
for a positive match, false
for a negative matchNullArgumentException
- assetId
is
null
mandatory
- This method must be implemented. void clearInClassTerms()
mandatory
- This method must be implemented. void matchDuration(Duration from, Duration to, boolean match)
from
- starting durationto
- ending durationmatch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyDuration(boolean match)
match
- true
to match docets with any duration,
false
to match docets with no durationmandatory
- This method must be implemented. void clearDurationTerms()
mandatory
- This method must be implemented. void matchAssetId(Id assetId, boolean match)
Id
for this query.assetId
- an asset Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- assetId
is
null
mandatory
- This method must be implemented. void clearAssetIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAssetQuery()
AssetQuery
is available. true
if an robjective query is available,
false
otherwisemandatory
- This method must be implemented. AssetQuery getAssetQuery()
OR
term.UnimplementedException
- supportsAssetQuery()
is false
optional
- This method must be implemented if
supportsObjectiveQuery()
is true.
void matchAnyAsset(boolean match)
match
- true
to match docets with any asset,
false
to match docets with no assetmandatory
- This method must be implemented. void clearAssetTerms()
mandatory
- This method must be implemented. void matchAssessmentId(Id assessmentId, boolean match)
Id
for this query.assessmentId
- an assessment Id
match
- true
for 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 docets with any assessment,
false
to match docets with no assessmentmandatory
- This method must be implemented. void clearAssessmentTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match syllabi
assigned to course catalogs.courseCatalogId
- a 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. DocetQueryRecord getDocetQueryRecord(Type docetRecordType) throws OperationFailedException
Docet
record Type.
Multiple record retrievals produce
a nested boolean OR
term.docetRecordType
- a docet record typeNullArgumentException
- docetRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(docetRecordType)
is false
mandatory
- This method must be implemented.