org.osid.course.program

Interface EnrollmentQuery

All Superinterfaces:

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

public interface EnrollmentQuery
extends OsidRelationshipQuery

This is the query for searching enrollments. 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	clearCourseCatalogIdTerms() Clears the course catalog Id terms.
void	clearCourseCatalogTerms() Clears the course catalog terms.
void	clearProgramOfferingIdTerms() Clears the program offering Id terms.
void	clearProgramOfferingTerms() Clears the program offering terms.
void	clearStudentIdTerms() Clears the student resource Id terms.
void	clearStudentTerms() Clears the student resource terms.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
EnrollmentQueryRecord	getEnrollmentQueryRecord(Type enrollmentRecordType) Gets the enrollment query record corresponding to the given Course record Type.
ProgramOfferingQuery	getProgramOfferingQuery() Gets the query for a program offering.
ResourceQuery	getStudentQuery() Gets the query for a student.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query.
void	matchProgramOfferingId(Id programOfferingId, boolean match) Sets the program offering Id for this query.
void	matchStudentId(Id resourceId, boolean match) Sets the student resource Id for this query.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsProgramOfferingQuery() Tests if a ProgramOffering is available.
boolean	supportsStudentQuery() Tests if a ResourceQuery 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

matchProgramOfferingId

void matchProgramOfferingId(Id programOfferingId,
                          boolean match)

Sets the program offering Id for this query.

Parameters:

programOfferingId - a program offering Id

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

Throws:

NullArgumentException - programOfferingId is null

Compliance:

mandatory - This method must be implemented.

clearProgramOfferingIdTerms

void clearProgramOfferingIdTerms()

Clears the program offering Id terms.

Compliance:

mandatory - This method must be implemented.

supportsProgramOfferingQuery

boolean supportsProgramOfferingQuery()

Tests if a ProgramOffering is available.

Returns:

true if a program offering query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramOfferingQuery

ProgramOfferingQuery getProgramOfferingQuery()

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

Returns:

the program offering query

Throws:

UnimplementedException - supportsProgramOfferingQuery() is false

Compliance:

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

clearProgramOfferingTerms

void clearProgramOfferingTerms()

Clears the program offering terms.

Compliance:

mandatory - This method must be implemented.

matchStudentId

void matchStudentId(Id resourceId,
                  boolean match)

Sets the student resource Id for this query.

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.

clearStudentIdTerms

void clearStudentIdTerms()

Clears the student resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsStudentQuery

boolean supportsStudentQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentQuery

ResourceQuery getStudentQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsStudentQuery() is false

Compliance:

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

clearStudentTerms

void clearStudentTerms()

Clears the student resource terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

Sets the course catalog Id for this query.

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.

getEnrollmentQueryRecord

EnrollmentQueryRecord getEnrollmentQueryRecord(Type enrollmentRecordType)
                                               throws OperationFailedException

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

Parameters:

enrollmentRecordType - an enrollment record type

Returns:

the enrollment query record

Throws:

NullArgumentException - enrollmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(enrollmentRecordType) is false

Compliance:

mandatory - This method must be implemented.