org.osid.course.registration

Interface ActivityBundleQuery

All Superinterfaces:

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

public interface ActivityBundleQuery
extends OsidObjectQuery

This is the query for searching activity bundles. 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	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	clearCreditsTerms() Clears the credit terms.
void	clearGradingOptionIdTerms() Clears the grade system Id terms.
void	clearGradingOptionTerms() Clears the grading option terms.
ActivityBundleQueryRecord	getActivityBundleQueryRecord(Type activityBundleRecordType) Gets the activity bundle query record corresponding to the given Course record Type.
ActivityQuery	getActivityQuery() Gets the query for an activity.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
CourseOfferingQuery	getCourseOfferingQuery() Gets the query for a course offering.
GradeSystemQuery	getGradingOptionQuery() Gets the query for a grading option.
void	matchActivityId(Id activityId, boolean match) Sets the activity Id for this query to match activity bundles that have a related course.
void	matchAnyActivity(boolean match) Matches activity bundles that have any activity.
void	matchAnyCredits(boolean match) Matches an activity bundle that has any credits assigned.
void	matchAnyGradingOption(boolean match) Matches activity bundles that have any grading option.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query to match activity bundles assigned to course catalogs.
void	matchCourseOfferingId(Id courseOfferingId, boolean match) Sets the course offering Id for this query.
void	matchCredits(java.math.BigDecimal min, java.math.BigDecimal max, boolean match) Matches activity bundles with credits between the given numbers inclusive.
void	matchGradingOptionId(Id gradeSystemId, boolean match) Sets the grade system Id for this query.
boolean	supportsActivityQuery() Tests if an ActivityQuery is available.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsCourseOfferingQuery() Tests if a CourseOfferingQuery is available.
boolean	supportsGradingOptionQuery() Tests if a GradeSystemQuery 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

Method Detail

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 course offering. Multiple retrievals produce a nested OR term.

Returns:

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

matchActivityId

void matchActivityId(Id activityId,
                   boolean match)

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

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 bundles that have any activity.

Parameters:

match - true to match activity bundles with any activity, false to match activity bundles with no activities

Compliance:

mandatory - This method must be implemented.

clearActivityTerms

void clearActivityTerms()

Clears the activity terms.

Compliance:

mandatory - This method must be implemented.

matchCredits

void matchCredits(java.math.BigDecimal min,
                java.math.BigDecimal max,
                boolean match)

Matches activity bundles with credits 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.

matchAnyCredits

void matchAnyCredits(boolean match)

Matches an activity bundle that has any credits assigned.

Parameters:

match - true to match activity bundles with any credits, false to match activity bundles with no credits

Compliance:

mandatory - This method must be implemented.

clearCreditsTerms

void clearCreditsTerms()

Clears the credit terms.

Compliance:

mandatory - This method must be implemented.

matchGradingOptionId

void matchGradingOptionId(Id gradeSystemId,
                        boolean match)

Sets the grade system Id for this query.

Parameters:

gradeSystemId - a grade system Id

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

Throws:

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearGradingOptionIdTerms

void clearGradingOptionIdTerms()

Clears the grade system Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradingOptionQuery

boolean supportsGradingOptionQuery()

Tests if a GradeSystemQuery is available.

Returns:

true if a grade system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradingOptionQuery

GradeSystemQuery getGradingOptionQuery()

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

Returns:

a grade system query

Throws:

UnimplementedException - supportsGradingOptionQuery() is false

Compliance:

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

matchAnyGradingOption

void matchAnyGradingOption(boolean match)

Matches activity bundles that have any grading option.

Parameters:

match - true to match activity bundles with any grading option, false to match activity bundles with no grading options

Compliance:

mandatory - This method must be implemented.

clearGradingOptionTerms

void clearGradingOptionTerms()

Clears the grading option 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 activity bundles 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.

getActivityBundleQueryRecord

ActivityBundleQueryRecord getActivityBundleQueryRecord(Type activityBundleRecordType)
                                                       throws OperationFailedException

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

Parameters:

activityBundleRecordType - an activity bundle record type

Returns:

the activity bundle query record

Throws:

NullArgumentException - activityBundleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityBundleRecordType) is false

Compliance:

mandatory - This method must be implemented.