org.osid.course.program

Interface ProgramOfferingQuery

All Superinterfaces:

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

public interface ProgramOfferingQuery
extends OsidRelationshipQuery

This is the query for searching program offerings. 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	clearCompletionRequirementsIdTerms() Clears the requisite Id terms.
void	clearCompletionRequirementsInfoTerms() Clears the completion requirements info terms.
void	clearCompletionRequirementsTerms() Clears the requisite terms.
void	clearCourseCatalogIdTerms() Clears the course catalog Id terms.
void	clearCourseCatalogTerms() Clears the course catalog terms.
void	clearCredentialIdTerms() Clears the credential Id terms.
void	clearCredentialTerms() Clears the credential terms.
void	clearInstructorIdTerms() Clears the instructor Id terms.
void	clearInstructorTerms() Clears the instructor terms.
void	clearMaximumSeatsTerms() Clears the maximum seats terms.
void	clearMinimumSeatsTerms() Clears the minimum seats terms.
void	clearNumberTerms() Clears the number terms.
void	clearProgramIdTerms() Clears the program Id terms.
void	clearProgramTerms() Clears the program terms.
void	clearRequiresRegistrationTerms() Clears the requires registration terms.
void	clearSponsorIdTerms() Clears the sponsor Id terms.
void	clearSponsorTerms() Clears the sponsor terms.
void	clearTermIdTerms() Clears the term Id terms.
void	clearTermTerms() Clears the reporting term terms.
void	clearTitleTerms() Clears the title terms.
void	clearURLTerms() Clears the url terms.
RequisiteQuery	getCompletionRequirementsQuery() Gets the query for a requisite.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
CredentialQuery	getCredentialQuery() Gets the query for a credential.
ResourceQuery	getInstructorQuery() Gets the query for an instructor.
ProgramOfferingQueryRecord	getProgramOfferingQueryRecord(Type programOfferingRecordType) Gets the program offering query record corresponding to the given ProgramOffering record Type.
ProgramQuery	getProgramQuery() Gets the query for a program.
ResourceQuery	getSponsorQuery() Gets the query for a sponsor.
TermQuery	getTermQuery() Gets the query for a reporting term.
void	matchAnyCompletionRequirements(boolean match) Matches programs that have any completion requirement requisite.
void	matchAnyCompletionRequirementsInfo(boolean match) Matches a program that has any completion requirements information assigned.
void	matchAnyCredential(boolean match) Matches programs that have any credentials.
void	matchAnyInstructor(boolean match) Matches program offerings that have any instructor.
void	matchAnyMaximumSeats(boolean match) Matches a program offering that has any maximum seating assigned.
void	matchAnyMinimumSeats(boolean match) Matches a program offering that has any minimum seating assigned.
void	matchAnyNumber(boolean match) Matches a program number that has any value.
void	matchAnySponsor(boolean match) Matches programs that have any sponsor.
void	matchAnyTitle(boolean match) Matches a title that has any value.
void	matchAnyURL(boolean match) Matches a url that has any value.
void	matchCompletionRequirementsId(Id ruleId, boolean match) Sets the requisite Id for this query.
void	matchCompletionRequirementsInfo(java.lang.String requirementsInfo, Type stringMatchType, boolean match) Matches programs with the prerequisites informational string.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query to match program offerings assigned to course catalogs.
void	matchCredentialId(Id credentialId, boolean match) Sets the credential Id for this query.
void	matchInstructorId(Id resourceId, boolean match) Sets the resource Id for this query to match program offerings that have an instructor.
void	matchMaximumSeats(long min, long max, boolean match) Matches program offerings with maximum seating between the given numbers inclusive.
void	matchMinimumSeats(long min, long max, boolean match) Matches program offerings with minimum seating between the given numbers inclusive.
void	matchNumber(java.lang.String number, Type stringMatchType, boolean match) Adds a program number for this query.
void	matchProgramId(Id programId, boolean match) Sets the program Id for this query to match program offerings that have a related program.
void	matchRequiresRegistration(boolean match) Matches program offerings that require registration.
void	matchSponsorId(Id resourceId, boolean match) Sets the resource Id for this query to match programs that have a sponsor.
void	matchTermId(Id termId, boolean match) Sets the term Id for this query to match program offerings that have a related term.
void	matchTitle(java.lang.String title, Type stringMatchType, boolean match) Adds a title for this query.
void	matchURL(java.lang.String url, Type stringMatchType, boolean match) Adds a class url for this query.
boolean	supportsCompletionRequirementsQuery() Tests if a RequisiteQuery is available.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsCredentialQuery() Tests if a CredentialQuery is available.
boolean	supportsInstructorQuery() Tests if a ResourceQuery is available.
boolean	supportsProgramQuery() Tests if a ProgramQuery is available.
boolean	supportsSponsorQuery() Tests if a ResourceQuery 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

matchProgramId

void matchProgramId(Id programId,
                  boolean match)

Sets the program Id for this query to match program offerings that have a related program.

Parameters:

programId - a program Id

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

Throws:

NullArgumentException - programId is null

Compliance:

mandatory - This method must be implemented.

clearProgramIdTerms

void clearProgramIdTerms()

Clears the program Id terms.

Compliance:

mandatory - This method must be implemented.

supportsProgramQuery

boolean supportsProgramQuery()

Tests if a ProgramQuery is available.

Returns:

true if a program query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramQuery

ProgramQuery getProgramQuery()

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

Returns:

the program query

Throws:

UnimplementedException - supportsProgramQuery() is false

Compliance:

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

clearProgramTerms

void clearProgramTerms()

Clears the program terms.

Compliance:

mandatory - This method must be implemented.

matchTermId

void matchTermId(Id termId,
               boolean match)

Sets the term Id for this query to match program 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 reporting term terms.

Compliance:

mandatory - This method must be implemented.

matchTitle

void matchTitle(java.lang.String title,
              Type stringMatchType,
              boolean match)

Adds a title for this query.

Parameters:

title - title string to match

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - title not of stringMatchType

NullArgumentException - title or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyTitle

void matchAnyTitle(boolean match)

Matches a title that has any value.

Parameters:

match - true to match program offerings with any title, false to match program offerings with no title

Compliance:

mandatory - This method must be implemented.

clearTitleTerms

void clearTitleTerms()

Clears the title terms.

Compliance:

mandatory - This method must be implemented.

matchNumber

void matchNumber(java.lang.String number,
               Type stringMatchType,
               boolean match)

Adds a program number for this query.

Parameters:

number - program number string to match

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - number not of stringMatchType

NullArgumentException - number or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyNumber

void matchAnyNumber(boolean match)

Matches a program number that has any value.

Parameters:

match - true to match program offerings with any number, false to match program offerings with no number

Compliance:

mandatory - This method must be implemented.

clearNumberTerms

void clearNumberTerms()

Clears the number terms.

Compliance:

mandatory - This method must be implemented.

matchInstructorId

void matchInstructorId(Id resourceId,
                     boolean match)

Sets the resource Id for this query to match program 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 program offerings that have any instructor.

Parameters:

match - true to match program offerings with any instructor, false to match program 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.

matchSponsorId

void matchSponsorId(Id resourceId,
                  boolean match)

Sets the resource Id for this query to match programs that have a sponsor.

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.

clearSponsorIdTerms

void clearSponsorIdTerms()

Clears the sponsor Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSponsorQuery

boolean supportsSponsorQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSponsorQuery

ResourceQuery getSponsorQuery()

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

Returns:

a resource query

Throws:

UnimplementedException - supportsSponsorQuery() is false

Compliance:

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

matchAnySponsor

void matchAnySponsor(boolean match)

Matches programs that have any sponsor.

Parameters:

match - true to match programs with any sponsor, false to match programs with no sponsors

Compliance:

mandatory - This method must be implemented.

clearSponsorTerms

void clearSponsorTerms()

Clears the sponsor terms.

Compliance:

mandatory - This method must be implemented.

matchCompletionRequirementsInfo

void matchCompletionRequirementsInfo(java.lang.String requirementsInfo,
                                   Type stringMatchType,
                                   boolean match)

Matches programs with the prerequisites informational string.

Parameters:

requirementsInfo - completion requirements string to match

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - requirementsInfo not of stringMatchType

NullArgumentException - requirementsInfo or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyCompletionRequirementsInfo

void matchAnyCompletionRequirementsInfo(boolean match)

Matches a program that has any completion requirements information assigned.

Parameters:

match - true to match programs with any completion requirements information, false otherwise

Compliance:

mandatory - This method must be implemented.

clearCompletionRequirementsInfoTerms

void clearCompletionRequirementsInfoTerms()

Clears the completion requirements info terms.

Compliance:

mandatory - This method must be implemented.

matchCompletionRequirementsId

void matchCompletionRequirementsId(Id ruleId,
                                 boolean match)

Sets the requisite Id for this query.

Parameters:

ruleId - a rule Id

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

Throws:

NullArgumentException - ruleId is null

Compliance:

mandatory - This method must be implemented.

clearCompletionRequirementsIdTerms

void clearCompletionRequirementsIdTerms()

Clears the requisite Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCompletionRequirementsQuery

boolean supportsCompletionRequirementsQuery()

Tests if a RequisiteQuery is available.

Returns:

true if a requisite query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCompletionRequirementsQuery

RequisiteQuery getCompletionRequirementsQuery()

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

Returns:

a requisite query

Throws:

UnimplementedException - supportsCompletionRequirementsQuery() is false

Compliance:

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

matchAnyCompletionRequirements

void matchAnyCompletionRequirements(boolean match)

Matches programs that have any completion requirement requisite.

Parameters:

match - true to match programs with any requisite, false to match programs with no requisites

Compliance:

mandatory - This method must be implemented.

clearCompletionRequirementsTerms

void clearCompletionRequirementsTerms()

Clears the requisite terms.

Compliance:

mandatory - This method must be implemented.

matchCredentialId

void matchCredentialId(Id credentialId,
                     boolean match)

Sets the credential Id for this query.

Parameters:

credentialId - a credential Id

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

Throws:

NullArgumentException - credentialId is null

Compliance:

mandatory - This method must be implemented.

clearCredentialIdTerms

void clearCredentialIdTerms()

Clears the credential Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCredentialQuery

boolean supportsCredentialQuery()

Tests if a CredentialQuery is available.

Returns:

true if a credential query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCredentialQuery

CredentialQuery getCredentialQuery()

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

Returns:

a credential query

Throws:

UnimplementedException - supportsCredentialQuery() is false

Compliance:

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

matchAnyCredential

void matchAnyCredential(boolean match)

Matches programs that have any credentials.

Parameters:

match - true to match programs with any credentials, false to match programs with no credentials

Compliance:

mandatory - This method must be implemented.

clearCredentialTerms

void clearCredentialTerms()

Clears the credential terms.

Compliance:

mandatory - This method must be implemented.

matchRequiresRegistration

void matchRequiresRegistration(boolean match)

Matches program offerings that require registration.

Parameters:

match - true to match program offerings requiring registration,, false to match program offerings not requiring registration

Compliance:

mandatory - This method must be implemented.

clearRequiresRegistrationTerms

void clearRequiresRegistrationTerms()

Clears the requires registration terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumSeats

void matchMinimumSeats(long min,
                     long max,
                     boolean match)

Matches program offerings with 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 a program offering that has any minimum seating assigned.

Parameters:

match - true to match program offerings with any minimum seats, false to match program offerings with no minimum seats

Compliance:

mandatory - This method must be implemented.

clearMinimumSeatsTerms

void clearMinimumSeatsTerms()

Clears the minimum seats terms.

Compliance:

mandatory - This method must be implemented.

matchMaximumSeats

void matchMaximumSeats(long min,
                     long max,
                     boolean match)

Matches program offerings with 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 a program offering that has any maximum seating assigned.

Parameters:

match - true to match program offerings with any maximum seats, false to match program offerings with no maximum seats

Compliance:

mandatory - This method must be implemented.

clearMaximumSeatsTerms

void clearMaximumSeatsTerms()

Clears the maximum seats terms.

Compliance:

mandatory - This method must be implemented.

matchURL

void matchURL(java.lang.String url,
            Type stringMatchType,
            boolean match)

Adds a class url for this query.

Parameters:

url - url string to match

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - url not of stringMatchType

NullArgumentException - url or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyURL

void matchAnyURL(boolean match)

Matches a url that has any value.

Parameters:

match - true to match program offerings with any url, false to match program offerings with no url

Compliance:

mandatory - This method must be implemented.

clearURLTerms

void clearURLTerms()

Clears the url 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 program offerings 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.

getProgramOfferingQueryRecord

ProgramOfferingQueryRecord getProgramOfferingQueryRecord(Type programOfferingRecordType)
                                                         throws OperationFailedException

Gets the program offering query record corresponding to the given ProgramOffering record Type. Multiple record retrievals produce a nested OR term.

Parameters:

programOfferingRecordType - a program offering record type

Returns:

the program offering query record

Throws:

NullArgumentException - programOfferingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programOfferingRecordType) is false

Compliance:

mandatory - This method must be implemented.