ActivityQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidSubjugateableQuery, OsidTemporalQuery, Suppliable
```
public interface ActivityQuery
extends OsidRelationshipQuery, OsidSubjugateableQuery
```
This is the query for searching activities. 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`	`clearActivityUnitIdTerms()` Clears the activity unit `Id` terms.
`void`	`clearActivityUnitTerms()` Clears the activity unit terms.
`void`	`clearBlackoutInclusiveTerms()` Clears all blackout inclusive terms.
`void`	`clearBlackoutTerms()` Clears all blackout terms.
`void`	`clearContactTerms()` Clears the contact terms.
`void`	`clearCourseCatalogIdTerms()` Clears the course catalog `Id` terms.
`void`	`clearCourseCatalogTerms()` Clears the course catalog terms.
`void`	`clearCourseOfferingIdTerms()` Clears the course offering `Id` terms.
`void`	`clearCourseOfferingTerms()` Clears the course offering terms.
`void`	`clearImplicitTerms()` Clears the implcit terms.
`void`	`clearInstructorIdTerms()` Clears the instructor `Id` terms.
`void`	`clearInstructorTerms()` Clears the instructor terms.
`void`	`clearMaximumSeatsTerms()` Clears the maximum seating terms.
`void`	`clearMeetingLocationIdTerms()` Clears the location `Id` terms.
`void`	`clearMeetingLocationTerms()` Clears the location `Id` terms.
`void`	`clearMeetingTimeInclusiveTerms()` Clears the meeting time inclusive terms.
`void`	`clearMeetingTimeTerms()` Clears the meeting time terms.
`void`	`clearMinimumSeatsTerms()` Clears the minimum seating terms.
`void`	`clearRecurringWeeklyTerms()` Clears the recurring weekly terms.
`void`	`clearScheduleIdTerms()` Clears the schedule `Id` terms.
`void`	`clearScheduleTerms()` Clears the schedule terms.
`void`	`clearSpecificMeetingTimeTerms()` Clears the specific date terms.
`void`	`clearSupersedingActivityIdTerms()` Clears the superseding activity `Id` terms.
`void`	`clearSupersedingActivityTerms()` Clears the superseding activity terms.
`void`	`clearTermIdTerms()` Clears the term `Id` terms.
`void`	`clearTermTerms()` Clears the term 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.
`ActivityQueryRecord`	`getActivityQueryRecord(Type activityRecordType)` Gets the activity query record corresponding to the given `Activity` record `Type.`
`ActivityUnitQuery`	`getActivityUnitQuery()` Gets the query for an activity unit.
`CourseCatalogQuery`	`getCourseCatalogQuery()` Gets the query for a course catalog.
`CourseOfferingQuery`	`getCourseOfferingQuery()` Gets the query for a coure offering.
`ResourceQuery`	`getInstructorQuery()` Gets the query for an instructor.
`LocationQuery`	`getMeetingLocationQuery()` Gets the query for a location.
`ScheduleQuery`	`getScheduleQuery()` Gets the query for a schedule.
`ActivityQuery`	`getSupersedingActivityQuery()` Gets the query for a superseding activity.
`TermQuery`	`getTermQuery()` Gets the query for a reporting term.
`void`	`matchActivityUnitId(Id activityUnitId, boolean match)` Sets the activity unit `Id` for this query.
`void`	`matchAnyBlackout(boolean match)` Matches an activity that has any blackout.
`void`	`matchAnyInstructor(boolean match)` Matches course offerings that have any instructor.
`void`	`matchAnyMaximumSeats(boolean match)` Matches activities with any maximum seating assigned.
`void`	`matchAnyMinimumSeats(boolean match)` Matches activities with any minimum seating assigned.
`void`	`matchAnySchedule(boolean match)` Matches an activity that has any schedule.
`void`	`matchAnySpecificMeetingTime(boolean match)` Matches an activity that has any specific date.
`void`	`matchAnySupersedingActivity(boolean match)` Matches an activity that has any superseding activity.
`void`	`matchAnyTotalTargetContactTime(boolean match)` Matches an activity that has any total contact assigned.
`void`	`matchAnyTotalTargetEffort(boolean match)` Matches an activity that has any total effort assigned.
`void`	`matchAnyTotalTargetIndividualEffort(boolean match)` Matches an activity that has any individual effort assigned.
`void`	`matchAnyWeeklyContactTime(boolean match)` Matches an activity that has any weekly contact time assigned.
`void`	`matchAnyWeeklyEffort(boolean match)` Matches an activity that has any weekly effort assigned.
`void`	`matchAnyWeeklyIndividualEffort(boolean match)` Matches an activity that has any weekly individual effort assigned.
`void`	`matchBlackout(DateTime date, boolean match)` Matches activities containing the given blackout date.
`void`	`matchBlackoutInclusive(DateTime start, DateTime end, boolean match)` Matches activities with blackouts within the given date range inclousive.
`void`	`matchContact(boolean match)` Matches activities that are contact activities.
`void`	`matchCourseCatalogId(Id courseCatalogId, boolean match)` Sets the course catalog `Id` for this query to match activities assigned to course catalogs.
`void`	`matchCourseOfferingId(Id courseOfferingId, boolean match)` Sets the course offering `Id` for this query.
`void`	`matchImplicit(boolean match)` Matches an activity that is implicitly generated.
`void`	`matchInstructorId(Id resourceId, boolean match)` Sets the resource `Id` for this query to match course offerings that have an instructor.
`void`	`matchMaximumSeats(long min, long max, boolean match)` Matches activities with a maximum seating between the given numbers inclusive.
`void`	`matchMeetingLocationId(Id locationId, boolean match)` Matches activities with any meeting location.
`void`	`matchMeetingTime(DateTime date, boolean match)` Matches activities where the given time falls within a denormalized meeting time inclusive.
`void`	`matchMeetingTimeInclusive(DateTime start, DateTime end, boolean match)` Matches activities with any denormalized meeting time within the given date range inclusive.
`void`	`matchMinimumSeats(long min, long max, boolean match)` Matches activities with a minimum seating between the given numbers inclusive.
`void`	`matchRecurringWeekly(boolean match)` Matches activities that recur weekly.
`void`	`matchScheduleId(Id scheduleId, boolean match)` Sets the schedule `Id` for this query.
`void`	`matchSpecificMeetingTime(DateTime start, DateTime end, boolean match)` Matches activities with specific dates between the given range inclusive.
`void`	`matchSupersedingActivityId(Id activityId, boolean match)` Sets the superseding activity `Id` for this query.
`void`	`matchTermId(Id termId, boolean match)` Sets the term `Id` for this query to match course offerings that have a related term.
`void`	`matchTotalTargetContactTime(Duration min, Duration max, boolean match)` Matches activities with a total contact time between the given durations inclusive.
`void`	`matchTotalTargetEffort(Duration min, Duration max, boolean match)` Matches activities with a total effort between the given durations inclusive.
`void`	`matchTotalTargetIndividualEffort(Duration min, Duration max, boolean match)` Matches activities with a individual effort between the given durations inclusive.
`void`	`matchWeeklyContactTime(Duration min, Duration max, boolean match)` Matches activities with a weekly contact time between the given durations inclusive.
`void`	`matchWeeklyEffort(Duration min, Duration max, boolean match)` Matches activities with a weekly effort between the given durations inclusive.
`void`	`matchWeeklyIndividualEffort(Duration min, Duration max, boolean match)` Matches activities with a weekly individual effort between the given durations inclusive.
`boolean`	`supportsActivityUnitQuery()` Tests if an `ActivityUnitQuery` is available.
`boolean`	`supportsCourseCatalogQuery()` Tests if a `CourseCatalogQuery` is available.
`boolean`	`supportsCourseOfferingQuery()` Tests if a `CourseOfferingQuery` is available.
`boolean`	`supportsInstructorQuery()` Tests if a `ResourceQuery` is available.
`boolean`	`supportsMeetingLocationQuery()` Tests if a `LocationQuery` is available.
`boolean`	`supportsScheduleQuery()` Tests if a `ScheduleQuery` is available.
`boolean`	`supportsSupersedingActivityQuery()` Tests if an `ActivityQuery` is available.
`boolean`	`supportsTermQuery()` Tests if a `TermQuery` is available.

Methods inherited from interface org.osid.OsidRelationshipQuery
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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.OsidTemporalQuery
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

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

Interface ActivityQuery

Method Summary

Methods inherited from interface org.osid.OsidRelationshipQuery

Methods inherited from interface org.osid.OsidObjectQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

Methods inherited from interface org.osid.OsidExtensibleQuery

Methods inherited from interface org.osid.Extensible

Methods inherited from interface org.osid.OsidQuery

Methods inherited from interface org.osid.OsidTemporalQuery

Method Detail

matchImplicit

clearImplicitTerms

matchActivityUnitId

clearActivityUnitIdTerms

supportsActivityUnitQuery

getActivityUnitQuery

clearActivityUnitTerms

matchCourseOfferingId

clearCourseOfferingIdTerms

supportsCourseOfferingQuery

getCourseOfferingQuery

clearCourseOfferingTerms

matchTermId

clearTermIdTerms

supportsTermQuery

getTermQuery

clearTermTerms

matchMeetingTime

clearMeetingTimeTerms

matchMeetingTimeInclusive

clearMeetingTimeInclusiveTerms

matchMeetingLocationId

clearMeetingLocationIdTerms

supportsMeetingLocationQuery

getMeetingLocationQuery

clearMeetingLocationTerms

matchScheduleId

clearScheduleIdTerms

supportsScheduleQuery

getScheduleQuery

matchAnySchedule

clearScheduleTerms

matchSupersedingActivityId

clearSupersedingActivityIdTerms

supportsSupersedingActivityQuery

getSupersedingActivityQuery

matchAnySupersedingActivity

clearSupersedingActivityTerms

matchSpecificMeetingTime

matchAnySpecificMeetingTime

clearSpecificMeetingTimeTerms

matchBlackout

matchAnyBlackout

clearBlackoutTerms

matchBlackoutInclusive

clearBlackoutInclusiveTerms

matchInstructorId

clearInstructorIdTerms

supportsInstructorQuery

getInstructorQuery

matchAnyInstructor

clearInstructorTerms

matchMinimumSeats

matchAnyMinimumSeats

clearMinimumSeatsTerms

matchMaximumSeats

matchAnyMaximumSeats

clearMaximumSeatsTerms

matchTotalTargetEffort

matchAnyTotalTargetEffort

clearTotalTargetEffortTerms

matchContact

clearContactTerms

matchTotalTargetContactTime

matchAnyTotalTargetContactTime

clearTotalTargetContactTimeTerms

matchTotalTargetIndividualEffort

matchAnyTotalTargetIndividualEffort

clearTotalTargetIndividualEffortTerms

matchRecurringWeekly