Interface | osid.course.ActivityUnitQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidOperableQuery | |||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching activity units. Each method
match specifies an | ||
Method | matchCourseId | ||
Description |
Sets the course | ||
Parameters | osid.id.Id | courseId | a course Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseIdTerms | ||
Description |
Clears the course | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseQuery | ||
Description |
Gets the query for a course. Multiple retrievals
produce a nested | ||
Return | osid.course.CourseQuery | the course query | |
Errors | UNIMPLEMENTED | supportsCourseQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseQuery() is
true. | |
Method | clearCourseTerms | ||
Description |
Clears the course terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTotalTargetEffort | ||
Description |
Matches activity units with a total effort between the given durations inclusive. | ||
Parameters | osid.calendaring.Duration | min | low range |
osid.calendaring.Duration | max | high range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
NULL_ARGUMENT | min or max is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyTotalTargetEffort | ||
Description |
Matches an activity unit that has any total effort assigned. | ||
Parameters | boolean | 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. | |
Method | clearTotalTargetEffortTerms | ||
Description |
Clears the total effort terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchContact | ||
Description |
Matches activity units that are contact activities. | ||
Parameters | boolean | match | true to match activity units that have contact, false
to match activity units with no contact |
Compliance | mandatory | This method must be implemented. | |
Method | clearContactTerms | ||
Description |
Clears the contact terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTotalTargetContactTime | ||
Description |
Matches activity units with a total contact time between the given durations inclusive. | ||
Parameters | osid.calendaring.Duration | min | low range |
osid.calendaring.Duration | max | high range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
NULL_ARGUMENT | min or max is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyTotalTargetContactTime | ||
Description |
Matches an activity unit that has any total contact assigned. | ||
Parameters | boolean | 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. | |
Method | clearTotalTargetContactTimeTerms | ||
Description |
Clears the total contact terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTotalTargetIndividualEffort | ||
Description |
Matches activity units with a individual effort between the given durations inclusive. | ||
Parameters | osid.calendaring.Duration | min | low range |
osid.calendaring.Duration | max | high range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
NULL_ARGUMENT | min or max is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyTotalTargetIndividualEffort | ||
Description |
Matches an activity unit that has any individual effort assigned. | ||
Parameters | boolean | 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. | |
Method | clearTotalTargetIndividualEffortTerms | ||
Description |
Clears the individual effort terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRecurringWeekly | ||
Description |
Matches activity units that recur weekly. | ||
Parameters | boolean | 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. | |
Method | clearRecurringWeeklyTerms | ||
Description |
Clears the recurring weekly terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWeeklyEffort | ||
Description |
Matches activity units with a weekly effort between the given durations inclusive. | ||
Parameters | osid.calendaring.Duration | min | low range |
osid.calendaring.Duration | max | high range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
NULL_ARGUMENT | min or max is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyWeeklyEffort | ||
Description |
Matches an activity unit that has any weekly effort assigned. | ||
Parameters | boolean | 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. | |
Method | clearWeeklyEffortTerms | ||
Description |
Clears the weekly effort terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWeeklyContactTime | ||
Description |
Matches activity units with a weekly contact time between the given durations inclusive. | ||
Parameters | osid.calendaring.Duration | min | low range |
osid.calendaring.Duration | max | high range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
NULL_ARGUMENT | min or max is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyWeeklyContactTime | ||
Description |
Matches an activity unit that has any weekly contact time assigned. | ||
Parameters | boolean | 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. | |
Method | clearWeeklyContactTimeTerms | ||
Description |
Clears the weekly contact time terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWeeklyIndividualEffort | ||
Description |
Matches activity units with a weekly individual effort between the given durations inclusive. | ||
Parameters | osid.calendaring.Duration | min | low range |
osid.calendaring.Duration | max | high range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
NULL_ARGUMENT | min or max is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyWeeklyIndividualEffort | ||
Description |
Matches an activity unit that has any weekly individual effort assigned. | ||
Parameters | boolean | 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. | |
Method | clearWeeklyIndividualEffortTerms | ||
Description |
Clears the weekly individual effort terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchLearningObjectiveId | ||
Description |
Sets the objective | ||
Parameters | osid.id.Id | objectiveId | an objective Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | objectiveId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearLearningObjectiveIdTerms | ||
Description |
Clears the objective | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsLearningObjectiveQuery | ||
Description |
Tests if a | ||
Return | boolean | true if an objective query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveQuery | ||
Description |
Gets the query for a learning objective. Multiple
retrievals produce a nested | ||
Return | osid.learning.ObjectiveQuery | an objective query | |
Errors | UNIMPLEMENTED | supportsLearningObjectiveQuery() is false | |
Compliance | optional | This method must be implemented if supportsLearningObjectiveQuery()
is true. | |
Method | matchAnyLearningObjective | ||
Description |
Matches activity units that have any learning objective. | ||
Parameters | boolean | 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. | |
Method | clearLearningObjectiveTerms | ||
Description |
Clears the learning objective terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchActivityId | ||
Description |
Sets the activity | ||
Parameters | osid.id.Id | activityId | an activity Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | activityId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearActivityIdTerms | ||
Description |
Clears the activity | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsActivityQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an activity query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityQuery | ||
Description |
Gets the query for an activity. Multiple retrievals
produce a nested | ||
Return | osid.course.ActivityQuery | the activity query | |
Errors | UNIMPLEMENTED | supportsActivityQuery() is false | |
Compliance | optional | This method must be implemented if supportsActivityQuery()
is true. | |
Method | matchAnyActivity | ||
Description |
Matches activity units that have any activity. | ||
Parameters | boolean | match | true to match activity units with any activity. false
to match activity units with no activity |
Compliance | mandatory | This method must be implemented. | |
Method | clearActivityTerms | ||
Description |
Clears the activity terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCourseCatalogId | ||
Description |
Sets the course catalog | ||
Parameters | osid.id.Id | courseCatalogId | the course catalog Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseCatalogId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseCatalogIdTerms | ||
Description |
Clears the course catalog | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseCatalogQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course catalog query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogQuery | ||
Description |
Gets the query for a course catalog. Multiple
retrievals produce a nested | ||
Return | osid.course.CourseCatalogQuery | the course catalog query | |
Errors | UNIMPLEMENTED | supportsCourseCatalogQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseCatalogQuery()
is true. | |
Method | clearCourseCatalogTerms | ||
Description |
Clears the course catalog terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitQueryRecord | ||
Description |
Gets the activity unit query record corresponding to
the given | ||
Parameters | osid.type.Type | activityUnitRecordType | an activity unit record type |
Return | osid.course.records.ActivityUnitQueryRecord | the activity unit query record | |
Errors | NULL_ARGUMENT | activityUnitRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(activityUnitRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |