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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested boolean OR term.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

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 {@code supportsModuleQuery()} is {@code 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 {@code supportsActivityUnitQuery()} is {@code 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 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 {@code supportsLearningObjectiveQuery()} is {@code 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 objective 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 {@code supportsObjectiveQuery()} is {@code 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 {@code supportsAssessmentQuery()} is {@code 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 {@code supportsCourseCatalogQuery()} is {@code 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.