org.osid.course.syllabus

Interface DocetQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchModuleId

void matchModuleId(Id moduleId,
                 boolean match)

Sets the module Id for this query.

Parameters:

moduleId - a module Id

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

Throws:

NullArgumentException - moduleId is null

Compliance:

mandatory - This method must be implemented.

clearModuleIdTerms

void clearModuleIdTerms()

Clears the module Id terms.

Compliance:

mandatory - This method must be implemented.

supportsModuleQuery

boolean supportsModuleQuery()

Tests if a module query is available.

Returns:

true if a module query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getModuleQuery

ModuleQuery getModuleQuery()

Gets the query for a module.

Returns:

the module query

Throws:

UnimplementedException - supportsModuleQuery() is false

Compliance:

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

clearModuleTerms

void clearModuleTerms()

Clears the module terms.

Compliance:

mandatory - This method must be implemented.

matchActivityUnitId

void matchActivityUnitId(Id activityUnitId,
                       boolean match)

Sets the activity unit Id for this query.

Parameters:

activityUnitId - an activity unit Id

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

Throws:

NullArgumentException - activityUnitId is null

Compliance:

mandatory - This method must be implemented.

clearActivityUnitIdTerms

void clearActivityUnitIdTerms()

Clears the activity unit Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActivityUnitQuery

boolean supportsActivityUnitQuery()

Tests if an activity unit query is available.

Returns:

true if an activity unit query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityUnitQuery

ActivityUnitQuery getActivityUnitQuery()

Gets the query for an activity unit.

Returns:

the activity unit query

Throws:

UnimplementedException - supportsActivityUnitQuery() is false

Compliance:

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

clearActivityUnitTerms

void clearActivityUnitTerms()

Clears the activity unit terms.

Compliance:

mandatory - This method must be implemented.

matchLearningObjectiveId

void matchLearningObjectiveId(Id objectiveId,
                            boolean match)

Sets the objective Id for this query.

Parameters:

objectiveId - an objective 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 terms.

Compliance:

mandatory - This method must be implemented.

supportsLearningObjectiveQuery

boolean supportsLearningObjectiveQuery()

Tests if an ObjectiveQuery is available for querying objectives.

Returns:

true if an robjective 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 a docet that has any objective assigned.

Parameters:

match - true to match docets with any objective, false to match docets with no objective

Compliance:

mandatory - This method must be implemented.

clearLearningObjectiveTerms

void clearLearningObjectiveTerms()

Clears the objective terms.

Compliance:

mandatory - This method must be implemented.

matchInClass

void matchInClass(boolean match)

Matches docets that occur in a class.

Parameters:

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

Throws:

NullArgumentException - assetId is null

Compliance:

mandatory - This method must be implemented.

clearInClassTerms

void clearInClassTerms()

Clears the in class terms.

Compliance:

mandatory - This method must be implemented.

matchDuration

void matchDuration(Duration from,
                 Duration to,
                 boolean match)

Matches durations between the given durations inclusive.

Parameters:

from - starting duration

to - ending duration

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyDuration

void matchAnyDuration(boolean match)

Matches a docet that has any duration assigned.

Parameters:

match - true to match docets with any duration, false to match docets with no duration

Compliance:

mandatory - This method must be implemented.

clearDurationTerms

void clearDurationTerms()

Clears the duration terms.

Compliance:

mandatory - This method must be implemented.

matchAssetId

void matchAssetId(Id assetId,
                boolean match)

Sets the asset Id for this query.

Parameters:

assetId - an asset Id

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

Throws:

NullArgumentException - assetId is null

Compliance:

mandatory - This method must be implemented.

clearAssetIdTerms

void clearAssetIdTerms()

Clears the asset Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAssetQuery

boolean supportsAssetQuery()

Tests if an AssetQuery is available.

Returns:

true if an robjective query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssetQuery

AssetQuery getAssetQuery()

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

Returns:

the asset query

Throws:

UnimplementedException - supportsAssetQuery() is false

Compliance:

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

matchAnyAsset

void matchAnyAsset(boolean match)

Matches a docet that has any asset assigned.

Parameters:

match - true to match docets with any asset, false to match docets with no asset

Compliance:

mandatory - This method must be implemented.

clearAssetTerms

void clearAssetTerms()

Clears the asset terms.

Compliance:

mandatory - This method must be implemented.

matchAssessmentId

void matchAssessmentId(Id assessmentId,
                     boolean match)

Sets the assessment Id for this query.

Parameters:

assessmentId - an assessment Id

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

Throws:

NullArgumentException - assessmentId is null

Compliance:

mandatory - This method must be implemented.

clearAssessmentIdTerms

void clearAssessmentIdTerms()

Clears the assessment Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAssessmentQuery

boolean supportsAssessmentQuery()

Tests if an AssessmentQuery is available.

Returns:

true if an assessment query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentQuery

AssessmentQuery getAssessmentQuery()

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

Returns:

the assessment query

Throws:

UnimplementedException - supportsAssessmentQuery() is false

Compliance:

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

matchAnyAssessment

void matchAnyAssessment(boolean match)

Matches an objective that has any assessment assigned.

Parameters:

match - true to match docets with any assessment, false to match docets with no assessment

Compliance:

mandatory - This method must be implemented.

clearAssessmentTerms

void clearAssessmentTerms()

Clears the assessment terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

Sets the docet Id for this query to match syllabi assigned to course catalogs.

Parameters:

courseCatalogId - a course catalog Id

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

Throws:

NullArgumentException - courseCatalogId is null

Compliance:

mandatory - This method must be implemented.

clearCourseCatalogIdTerms

void clearCourseCatalogIdTerms()

Clears the course catalog Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseCatalogQuery

boolean supportsCourseCatalogQuery()

Tests if an CourseCatalogQuery is available.

Returns:

true if a course catalog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseCatalogQuery

CourseCatalogQuery getCourseCatalogQuery()

Gets the query for a course catalog query. Multiple retrievals produce a nested OR term.

Returns:

the course catalog query

Throws:

UnimplementedException - supportsCourseCatalogQuery() is false

Compliance:

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

clearCourseCatalogTerms

void clearCourseCatalogTerms()

Clears the course catalog terms.

Compliance:

mandatory - This method must be implemented.

getDocetQueryRecord

DocetQueryRecord getDocetQueryRecord(Type docetRecordType)
                                     throws OperationFailedException

Gets the docet query record corresponding to the given Docet record Type. Multiple record retrievals produce a nested boolean OR term.

Parameters:

docetRecordType - a docet record type

Returns:

the docet query record

Throws:

NullArgumentException - docetRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(docetRecordType) is false

Compliance:

mandatory - This method must be implemented.