org.osid.course

Interface ActivityUnitQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

public interface ActivityUnitQuery
extends OsidObjectQuery, OsidOperableQuery, OsidSubjugateableQuery

This is the query for searching activity units. Each method match 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	clearActivityIdTerms() Clears the activity Id terms.
void	clearActivityTerms() Clears the activity terms.
void	clearContactTerms() Clears the contact 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	clearLearningObjectiveIdTerms() Clears the objective Id terms.
void	clearLearningObjectiveTerms() Clears the learning objective terms.
void	clearRecurringWeeklyTerms() Clears the recurring weekly terms.
void	clearTotalTargetContactTimeTerms() Clears the total contact terms.
void	clearTotalTargetEffortTerms() Clears the total effort terms.
void	clearTotalTargetIndividualEffortTerms() Clears the individual effort terms.
void	clearWeeklyContactTimeTerms() Clears the weekly contact time terms.
void	clearWeeklyEffortTerms() Clears the weekly effort terms.
void	clearWeeklyIndividualEffortTerms() Clears the weekly individual effort terms.
ActivityQuery	getActivityQuery() Gets the query for an activity.
ActivityUnitQueryRecord	getActivityUnitQueryRecord(Type activityUnitRecordType) Gets the activity unit query record corresponding to the given Course record Type.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
CourseQuery	getCourseQuery() Gets the query for a course.
ObjectiveQuery	getLearningObjectiveQuery() Gets the query for a learning objective.
void	matchActivityId(Id activityId, boolean match) Sets the activity Id for this query to match activity units that have a related activity.
void	matchAnyActivity(boolean match) Matches activity units that have any activity.
void	matchAnyLearningObjective(boolean match) Matches activity units that have any learning objective.
void	matchAnyTotalTargetContactTime(boolean match) Matches an activity unit that has any total contact assigned.
void	matchAnyTotalTargetEffort(boolean match) Matches an activity unit that has any total effort assigned.
void	matchAnyTotalTargetIndividualEffort(boolean match) Matches an activity unit that has any individual effort assigned.
void	matchAnyWeeklyContactTime(boolean match) Matches an activity unit that has any weekly contact time assigned.
void	matchAnyWeeklyEffort(boolean match) Matches an activity unit that has any weekly effort assigned.
void	matchAnyWeeklyIndividualEffort(boolean match) Matches an activity unit that has any weekly individual effort assigned.
void	matchContact(boolean match) Matches activity units that are contact activities.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query to match courses assigned to course catalogs.
void	matchCourseId(Id courseId, boolean match) Sets the course Id for this query to match activity units that have a related course.
void	matchLearningObjectiveId(Id objectiveId, boolean match) Sets the objective Id for this query.
void	matchRecurringWeekly(boolean match) Matches activity units that recur weekly.
void	matchTotalTargetContactTime(Duration min, Duration max, boolean match) Matches activity units with a total contact time between the given durations inclusive.
void	matchTotalTargetEffort(Duration min, Duration max, boolean match) Matches activity units with a total effort between the given durations inclusive.
void	matchTotalTargetIndividualEffort(Duration min, Duration max, boolean match) Matches activity units with a individual effort between the given durations inclusive.
void	matchWeeklyContactTime(Duration min, Duration max, boolean match) Matches activity units with a weekly contact time between the given durations inclusive.
void	matchWeeklyEffort(Duration min, Duration max, boolean match) Matches activity units with a weekly effort between the given durations inclusive.
void	matchWeeklyIndividualEffort(Duration min, Duration max, boolean match) Matches activity units with a weekly individual effort between the given durations inclusive.
boolean	supportsActivityQuery() Tests if an ActivityQuery is available.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsCourseQuery() Tests if a CourseQuery is available.
boolean	supportsLearningObjectiveQuery() Tests if a ObjectiveQuery is available.

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.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchCourseId

void matchCourseId(Id courseId,
                 boolean match)

Sets the course Id for this query to match activity units that have a related course.

Parameters:

courseId - a course Id

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

Throws:

NullArgumentException - courseId is null

Compliance:

mandatory - This method must be implemented.

clearCourseIdTerms

void clearCourseIdTerms()

Clears the course Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseQuery

boolean supportsCourseQuery()

Tests if a CourseQuery is available.

Returns:

true if a course query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseQuery

CourseQuery getCourseQuery()

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

Returns:

the course query

Throws:

UnimplementedException - supportsCourseQuery() is false

Compliance:

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

clearCourseTerms

void clearCourseTerms()

Clears the course terms.

Compliance:

mandatory - This method must be implemented.

matchTotalTargetEffort

void matchTotalTargetEffort(Duration min,
                          Duration max,
                          boolean match)

Matches activity units with a total effort between the given durations inclusive.

Parameters:

min - low range

max - high range

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

Throws:

InvalidArgumentException - max is less than min

NullArgumentException - min or max is null

Compliance:

mandatory - This method must be implemented.

matchAnyTotalTargetEffort

void matchAnyTotalTargetEffort(boolean match)

Matches an activity unit that has any total effort assigned.

Parameters:

match - true to match activity units with any total effort, false to match activity units with no total effort

Compliance:

mandatory - This method must be implemented.

clearTotalTargetEffortTerms

void clearTotalTargetEffortTerms()

Clears the total effort terms.

Compliance:

mandatory - This method must be implemented.

matchContact

void matchContact(boolean match)

Matches activity units that are contact activities.

Parameters:

match - true to match activity units that have contact, false to match activity units with no contact

Compliance:

mandatory - This method must be implemented.

clearContactTerms

void clearContactTerms()

Clears the contact terms.

Compliance:

mandatory - This method must be implemented.

matchTotalTargetContactTime

void matchTotalTargetContactTime(Duration min,
                               Duration max,
                               boolean match)

Matches activity units with a total contact time between the given durations inclusive.

Parameters:

min - low range

max - high range

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

Throws:

InvalidArgumentException - max is less than min

NullArgumentException - min or max is null

Compliance:

mandatory - This method must be implemented.

matchAnyTotalTargetContactTime

void matchAnyTotalTargetContactTime(boolean match)

Matches an activity unit that has any total contact assigned.

Parameters:

match - true to match activity units with any total contatc, false to match activity units with no total contact

Compliance:

mandatory - This method must be implemented.

clearTotalTargetContactTimeTerms

void clearTotalTargetContactTimeTerms()

Clears the total contact terms.

Compliance:

mandatory - This method must be implemented.

matchTotalTargetIndividualEffort

void matchTotalTargetIndividualEffort(Duration min,
                                    Duration max,
                                    boolean match)

Matches activity units with a individual effort between the given durations inclusive.

Parameters:

min - low range

max - high range

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

Throws:

InvalidArgumentException - max is less than min

NullArgumentException - min or max is null

Compliance:

mandatory - This method must be implemented.

matchAnyTotalTargetIndividualEffort

void matchAnyTotalTargetIndividualEffort(boolean match)

Matches an activity unit that has any individual effort assigned.

Parameters:

match - true to match activity units with any individual effort, false to match activity units with no individual effort

Compliance:

mandatory - This method must be implemented.

clearTotalTargetIndividualEffortTerms

void clearTotalTargetIndividualEffortTerms()

Clears the individual effort terms.

Compliance:

mandatory - This method must be implemented.

matchRecurringWeekly

void matchRecurringWeekly(boolean match)

Matches activity units that recur weekly.

Parameters:

match - true to match activity units that recur weekly, false to match activity units with no weekly recurrance

Compliance:

mandatory - This method must be implemented.

clearRecurringWeeklyTerms

void clearRecurringWeeklyTerms()

Clears the recurring weekly terms.

Compliance:

mandatory - This method must be implemented.

matchWeeklyEffort

void matchWeeklyEffort(Duration min,
                     Duration max,
                     boolean match)

Matches activity units with a weekly effort between the given durations inclusive.

Parameters:

min - low range

max - high range

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

Throws:

InvalidArgumentException - max is less than min

NullArgumentException - min or max is null

Compliance:

mandatory - This method must be implemented.

matchAnyWeeklyEffort

void matchAnyWeeklyEffort(boolean match)

Matches an activity unit that has any weekly effort assigned.

Parameters:

match - true to match activity units with any weekly effort, false to match activity units with no weekly effort

Compliance:

mandatory - This method must be implemented.

clearWeeklyEffortTerms

void clearWeeklyEffortTerms()

Clears the weekly effort terms.

Compliance:

mandatory - This method must be implemented.

matchWeeklyContactTime

void matchWeeklyContactTime(Duration min,
                          Duration max,
                          boolean match)

Matches activity units with a weekly contact time between the given durations inclusive.

Parameters:

min - low range

max - high range

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

Throws:

InvalidArgumentException - max is less than min

NullArgumentException - min or max is null

Compliance:

mandatory - This method must be implemented.

matchAnyWeeklyContactTime

void matchAnyWeeklyContactTime(boolean match)

Matches an activity unit that has any weekly contact time assigned.

Parameters:

match - true to match activity units with any weekly contact time, false to match activity units with no weekly contact time

Compliance:

mandatory - This method must be implemented.

clearWeeklyContactTimeTerms

void clearWeeklyContactTimeTerms()

Clears the weekly contact time terms.

Compliance:

mandatory - This method must be implemented.

matchWeeklyIndividualEffort

void matchWeeklyIndividualEffort(Duration min,
                               Duration max,
                               boolean match)

Matches activity units with a weekly individual effort between the given durations inclusive.

Parameters:

min - low range

max - high range

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

Throws:

InvalidArgumentException - max is less than min

NullArgumentException - min or max is null

Compliance:

mandatory - This method must be implemented.

matchAnyWeeklyIndividualEffort

void matchAnyWeeklyIndividualEffort(boolean match)

Matches an activity unit that has any weekly individual effort assigned.

Parameters:

match - true to match activity units with any weekly individual effort, false to match activity units with no weekly individual effort

Compliance:

mandatory - This method must be implemented.

clearWeeklyIndividualEffortTerms

void clearWeeklyIndividualEffortTerms()

Clears the weekly individual effort 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 if 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 a ObjectiveQuery is available.

Returns:

true if an objective query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveQuery

ObjectiveQuery getLearningObjectiveQuery()

Gets the query for a learning objective. Multiple retrievals produce a nested OR term.

Returns:

an objective query

Throws:

UnimplementedException - supportsLearningObjectiveQuery() is false

Compliance:

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

matchAnyLearningObjective

void matchAnyLearningObjective(boolean match)

Matches activity units that have any learning objective.

Parameters:

match - true to match activity units with any learning objective, false to match activity units with no learning objectives

Compliance:

mandatory - This method must be implemented.

clearLearningObjectiveTerms

void clearLearningObjectiveTerms()

Clears the learning objective terms.

Compliance:

mandatory - This method must be implemented.

matchActivityId

void matchActivityId(Id activityId,
                   boolean match)

Sets the activity Id for this query to match activity units that have a related activity.

Parameters:

activityId - an activity Id

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

Throws:

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActivityIdTerms

void clearActivityIdTerms()

Clears the activity Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActivityQuery

boolean supportsActivityQuery()

Tests if an ActivityQuery is available.

Returns:

true if an activity query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityQuery

ActivityQuery getActivityQuery()

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

Returns:

the activity query

Throws:

UnimplementedException - supportsActivityQuery() is false

Compliance:

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

matchAnyActivity

void matchAnyActivity(boolean match)

Matches activity units that have any activity.

Parameters:

match - true to match activity units with any activity. false to match activity units with no activity

Compliance:

mandatory - This method must be implemented.

clearActivityTerms

void clearActivityTerms()

Clears the activity terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

Sets the course catalog Id for this query to match courses assigned to course catalogs.

Parameters:

courseCatalogId - the 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 a 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. 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.

getActivityUnitQueryRecord

ActivityUnitQueryRecord getActivityUnitQueryRecord(Type activityUnitRecordType)
                                                   throws OperationFailedException

Gets the activity unit query record corresponding to the given Course record Type. Multiple record retrievals produce a nested OR term.

Parameters:

activityUnitRecordType - an activity unit record type

Returns:

the activity unit query record

Throws:

NullArgumentException - activityUnitRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityUnitRecordType) is false

Compliance:

mandatory - This method must be implemented.