OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.ActivityUnitQuery
Implementsosid.OsidObjectQuery
osid.OsidOperableQuery
osid.OsidSubjugateableQuery
Description

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.

MethodmatchCourseId
Description

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

Parametersosid.id.IdcourseIda course Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseIdTerms
Description

Clears the course Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseQuery
Description

Tests if a CourseQuery is available.

Returnboolean true if a course query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseQuery
Description

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

Returnosid.course.CourseQuerythe course query
ErrorsUNIMPLEMENTED supportsCourseQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseQuery() is true.
MethodclearCourseTerms
Description

Clears the course terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTotalTargetEffort
Description

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

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTotalTargetEffort
Description

Matches an activity unit that has any total effort assigned.

Parametersbooleanmatch true to match activity units with any total effort, false to match activity units with no total effort
CompliancemandatoryThis method must be implemented.
MethodclearTotalTargetEffortTerms
Description

Clears the total effort terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContact
Description

Matches activity units that are contact activities.

Parametersbooleanmatch true to match activity units that have contact, false to match activity units with no contact
CompliancemandatoryThis method must be implemented.
MethodclearContactTerms
Description

Clears the contact terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTotalTargetContactTime
Description

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

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTotalTargetContactTime
Description

Matches an activity unit that has any total contact assigned.

Parametersbooleanmatch true to match activity units with any total contatc, false to match activity units with no total contact
CompliancemandatoryThis method must be implemented.
MethodclearTotalTargetContactTimeTerms
Description

Clears the total contact terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTotalTargetIndividualEffort
Description

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

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTotalTargetIndividualEffort
Description

Matches an activity unit that has any individual effort assigned.

Parametersbooleanmatch true to match activity units with any individual effort, false to match activity units with no individual effort
CompliancemandatoryThis method must be implemented.
MethodclearTotalTargetIndividualEffortTerms
Description

Clears the individual effort terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRecurringWeekly
Description

Matches activity units that recur weekly.

Parametersbooleanmatch true to match activity units that recur weekly, false to match activity units with no weekly recurrance
CompliancemandatoryThis method must be implemented.
MethodclearRecurringWeeklyTerms
Description

Clears the recurring weekly terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeeklyEffort
Description

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

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeeklyEffort
Description

Matches an activity unit that has any weekly effort assigned.

Parametersbooleanmatch true to match activity units with any weekly effort, false to match activity units with no weekly effort
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyEffortTerms
Description

Clears the weekly effort terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeeklyContactTime
Description

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

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeeklyContactTime
Description

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

Parametersbooleanmatch true to match activity units with any weekly contact time, false to match activity units with no weekly contact time
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyContactTimeTerms
Description

Clears the weekly contact time terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWeeklyIndividualEffort
Description

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

Parametersosid.calendaring.Durationminlow range
osid.calendaring.Durationmaxhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT max is less than min
NULL_ARGUMENT min or max is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyWeeklyIndividualEffort
Description

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

Parametersbooleanmatch true to match activity units with any weekly individual effort, false to match activity units with no weekly individual effort
CompliancemandatoryThis method must be implemented.
MethodclearWeeklyIndividualEffortTerms
Description

Clears the weekly individual effort terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLearningObjectiveId
Description

Sets the objective Id for this query.

Parametersosid.id.IdobjectiveIdan objective Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveId is null
CompliancemandatoryThis method must be implemented.
MethodclearLearningObjectiveIdTerms
Description

Clears the objective Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLearningObjectiveQuery
Description

Tests if a ObjectiveQuery is available.

Returnboolean true if an objective query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveQuery
Description

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

Returnosid.learning.ObjectiveQueryan objective query
ErrorsUNIMPLEMENTED supportsLearningObjectiveQuery() is false
ComplianceoptionalThis method must be implemented if supportsLearningObjectiveQuery() is true.
MethodmatchAnyLearningObjective
Description

Matches activity units that have any learning objective.

Parametersbooleanmatch true to match activity units with any learning objective, false to match activity units with no learning objectives
CompliancemandatoryThis method must be implemented.
MethodclearLearningObjectiveTerms
Description

Clears the learning objective terms.

CompliancemandatoryThis method must be implemented.
MethodmatchActivityId
Description

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

Parametersosid.id.IdactivityIdan activity Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT activityId is null
CompliancemandatoryThis method must be implemented.
MethodclearActivityIdTerms
Description

Clears the activity Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsActivityQuery
Description

Tests if an ActivityQuery is available.

Returnboolean true if an activity query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetActivityQuery
Description

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

Returnosid.course.ActivityQuerythe activity query
ErrorsUNIMPLEMENTED supportsActivityQuery() is false
ComplianceoptionalThis method must be implemented if supportsActivityQuery() is true.
MethodmatchAnyActivity
Description

Matches activity units that have any activity.

Parametersbooleanmatch true to match activity units with any activity. false to match activity units with no activity
CompliancemandatoryThis method must be implemented.
MethodclearActivityTerms
Description

Clears the activity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

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

Parametersosid.id.IdcourseCatalogIdthe course catalog Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseCatalogId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseCatalogIdTerms
Description

Clears the course catalog Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseCatalogQuery
Description

Tests if a CourseCatalogQuery is available.

Returnboolean true if a course catalog query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogQuery
Description

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

Returnosid.course.CourseCatalogQuerythe course catalog query
ErrorsUNIMPLEMENTED supportsCourseCatalogQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseCatalogQuery() is true.
MethodclearCourseCatalogTerms
Description

Clears the course catalog terms.

CompliancemandatoryThis method must be implemented.
MethodgetActivityUnitQueryRecord
Description

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

Parametersosid.type.TypeactivityUnitRecordTypean activity unit record type
Returnosid.course.records.ActivityUnitQueryRecordthe activity unit query record
ErrorsNULL_ARGUMENT activityUnitRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityUnitRecordType) is false
CompliancemandatoryThis method must be implemented.