Interface | osid.course.ActivityQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching activities. Each method
match specifies an | ||
Method | matchImplicit | ||
Description |
Matches an activity that is implicitly generated. | ||
Parameters | boolean | match | true to match activities implicitly generated, false
to match activities explicitly defined |
Compliance | mandatory | This method must be implemented. | |
Method | clearImplicitTerms | ||
Description |
Clears the implcit terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchActivityUnitId | ||
Description |
Sets the activity unit | ||
Parameters | osid.id.Id | activityUnitId | an activity unit Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | activityUnitId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearActivityUnitIdTerms | ||
Description |
Clears the activity unit | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsActivityUnitQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an activity unit query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityUnitQuery | ||
Description |
Gets the query for an activity unit. Multiple
retrievals produce a nested | ||
Return | osid.course.ActivityUnitQuery | the activity unit query | |
Errors | UNIMPLEMENTED | supportsActivityUnitQuery() is false | |
Compliance | optional | This method must be implemented if supportsActivityUnitQuery()
is true. | |
Method | clearActivityUnitTerms | ||
Description |
Clears the activity unit terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCourseOfferingId | ||
Description |
Sets the course offering | ||
Parameters | osid.id.Id | courseOfferingId | a course offering Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseOfferingId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseOfferingIdTerms | ||
Description |
Clears the course offering | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseOfferingQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course offering query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseOfferingQuery | ||
Description |
Gets the query for a coure offering. Multiple
retrievals produce a nested | ||
Return | osid.course.CourseOfferingQuery | the course offering query | |
Errors | UNIMPLEMENTED | supportsCourseOfferingQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseOfferingQuery()
is true. | |
Method | clearCourseOfferingTerms | ||
Description |
Clears the course offering terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTermId | ||
Description |
Sets the term | ||
Parameters | osid.id.Id | termId | a term Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | termId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearTermIdTerms | ||
Description |
Clears the term | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsTermQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a term query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTermQuery | ||
Description |
Gets the query for a reporting term. Multiple
retrievals produce a nested | ||
Return | osid.course.TermQuery | the term query | |
Errors | UNIMPLEMENTED | supportsTermQuery() is false | |
Compliance | optional | This method must be implemented if supportsTermQuery() is
true. | |
Method | clearTermTerms | ||
Description |
Clears the term terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMeetingTime | ||
Description |
Matches activities where the given time falls within a denormalized meeting time inclusive. | ||
Parameters | osid.calendaring.DateTime | date | a date |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | date is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMeetingTimeTerms | ||
Description |
Clears the meeting time terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMeetingTimeInclusive | ||
Description |
Matches activities with any denormalized meeting time within the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | start | a start date |
osid.calendaring.DateTime | end | an end date | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | start or end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearMeetingTimeInclusiveTerms | ||
Description |
Clears the meeting time inclusive terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMeetingLocationId | ||
Description |
Matches activities with any meeting location. | ||
Parameters | osid.id.Id | locationId | a location Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | locationId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMeetingLocationIdTerms | ||
Description |
Clears the location | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsMeetingLocationQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a location query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMeetingLocationQuery | ||
Description |
Gets the query for a location. Multiple retrievals
produce a nested | ||
Return | osid.mapping.LocationQuery | the location query | |
Errors | UNIMPLEMENTED | supportsMeetingLocationQuery() is false | |
Compliance | optional | This method must be implemented if supportsMeetingLocationQuery()
is true. | |
Method | clearMeetingLocationTerms | ||
Description |
Clears the location | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchScheduleId | ||
Description |
Sets the schedule | ||
Parameters | osid.id.Id | scheduleId | a schedule Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | scheduleId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearScheduleIdTerms | ||
Description |
Clears the schedule | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsScheduleQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a schedule query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleQuery | ||
Description |
Gets the query for a schedule. Multiple retrievals
produce a nested | ||
Return | osid.calendaring.ScheduleQuery | the schedule query | |
Errors | UNIMPLEMENTED | supportsScheduleQuery() is false | |
Compliance | optional | This method must be implemented if supportsScheduleQuery()
is true. | |
Method | matchAnySchedule | ||
Description |
Matches an activity that has any schedule. | ||
Parameters | boolean | match | true to match activitiies with any schedule, false
to match activitiies with no schedule |
Compliance | mandatory | This method must be implemented. | |
Method | clearScheduleTerms | ||
Description |
Clears the schedule terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSupersedingActivityId | ||
Description |
Sets the superseding activity | ||
Parameters | osid.id.Id | activityId | a superseding 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 | clearSupersedingActivityIdTerms | ||
Description |
Clears the superseding activity | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSupersedingActivityQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a superseding activity query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingActivityQuery | ||
Description |
Gets the query for a superseding activity. Multiple
retrievals produce a nested | ||
Return | osid.course.ActivityQuery | the superseding activity query | |
Errors | UNIMPLEMENTED | supportsSupersedingActivityQuery() is false | |
Compliance | optional | This method must be implemented if
supportsSupersedingActivityQuery() is true. | |
Method | matchAnySupersedingActivity | ||
Description |
Matches an activity that has any superseding activity. | ||
Parameters | boolean | match | true to match activitiies with any superseding activity,
false to match activitiies with no superseding activities |
Compliance | mandatory | This method must be implemented. | |
Method | clearSupersedingActivityTerms | ||
Description |
Clears the superseding activity terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSpecificMeetingTime | ||
Description |
Matches activities with specific dates between the given range inclusive. | ||
Parameters | osid.calendaring.DateTime | start | start date |
osid.calendaring.DateTime | end | end date | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | end is less than start | |
NULL_ARGUMENT | start or end is zero | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnySpecificMeetingTime | ||
Description |
Matches an activity that has any specific date. | ||
Parameters | boolean | match | true to match activitiies with any specific date,
false to match activitiies with no specific dates |
Compliance | mandatory | This method must be implemented. | |
Method | clearSpecificMeetingTimeTerms | ||
Description |
Clears the specific date terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBlackout | ||
Description |
Matches activities containing the given blackout date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | date is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyBlackout | ||
Description |
Matches an activity that has any blackout. | ||
Parameters | boolean | match | true to match activitiies with any blackout, false
to match activitiies with no blackouts |
Compliance | mandatory | This method must be implemented. | |
Method | clearBlackoutTerms | ||
Description |
Clears all blackout terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchBlackoutInclusive | ||
Description |
Matches activities with blackouts within the given date range inclousive. | ||
Parameters | osid.calendaring.DateTime | start | a start date |
osid.calendaring.DateTime | end | an end date | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | star t or end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearBlackoutInclusiveTerms | ||
Description |
Clears all blackout inclusive terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchInstructorId | ||
Description |
Sets the resource | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearInstructorIdTerms | ||
Description |
Clears the instructor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsInstructorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInstructorQuery | ||
Description |
Gets the query for an instructor. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | a resource query | |
Errors | UNIMPLEMENTED | supportsInstructorQuery() is false | |
Compliance | optional | This method must be implemented if supportsInstructorQuery()
is true. | |
Method | matchAnyInstructor | ||
Description |
Matches course offerings that have any instructor. | ||
Parameters | boolean | match | true to match course offerings with any instructor,
false to match course offerings with no instructors |
Compliance | mandatory | This method must be implemented. | |
Method | clearInstructorTerms | ||
Description |
Clears the instructor terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumSeats | ||
Description |
Matches activities with a minimum seating between the given numbers inclusive. | ||
Parameters | cardinal | min | low number |
cardinal | max | high number | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyMinimumSeats | ||
Description |
Matches activities with any minimum seating assigned. | ||
Parameters | boolean | match | true to match activities with any minimum seating,
false to match activities with no minimum seating |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumSeatsTerms | ||
Description |
Clears the minimum seating terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMaximumSeats | ||
Description |
Matches activities with a maximum seating between the given numbers inclusive. | ||
Parameters | cardinal | min | low number |
cardinal | max | high number | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | max is less than min | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyMaximumSeats | ||
Description |
Matches activities with any maximum seating assigned. | ||
Parameters | boolean | match | true to match activities with any maximum seating,
false to match activities with no maximum seating |
Compliance | mandatory | This method must be implemented. | |
Method | clearMaximumSeatsTerms | ||
Description |
Clears the maximum seating terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTotalTargetEffort | ||
Description |
Matches activities 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 that has any total effort assigned. | ||
Parameters | boolean | match | true to match activities with any total effort, false
to match activities 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 activities that are contact activities. | ||
Parameters | boolean | match | true to match activities that have contact, false
to match activities 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 activities 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 that has any total contact assigned. | ||
Parameters | boolean | match | true to match activities with any total contatc,
false to match activities 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 activities 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 that has any individual effort assigned. | ||
Parameters | boolean | match | true to match activities with any individual effort,
false to match activities 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 activities that recur weekly. | ||
Parameters | boolean | match | true to match activities that recur weekly, false
to match activities 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 activities 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 that has any weekly effort assigned. | ||
Parameters | boolean | match | true to match activities with any weekly effort,
false to match activities 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 activities 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 that has any weekly contact time assigned. | ||
Parameters | boolean | match | true to match activities with any weekly contact time,
false to match activities 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 activities 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 that has any weekly individual effort assigned. | ||
Parameters | boolean | match | true to match activities with any weekly individual effort,
false to match activities 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 | 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 | getActivityQueryRecord | ||
Description |
Gets the activity query record corresponding to the
given | ||
Parameters | osid.type.Type | activityRecordType | an activity record type |
Return | osid.course.records.ActivityQueryRecord | the activity query record | |
Errors | NULL_ARGUMENT | activityRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(activityRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |