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.
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. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchProgramId(Id programId, boolean match)
Id
for this query to match program
offerings that have a related program.programId
- a program Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- programId
is
null
mandatory
- This method must be implemented. void clearProgramIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsProgramQuery()
ProgramQuery
is available. true
if a program query is available,
false
otherwisemandatory
- This method must be implemented. ProgramQuery getProgramQuery()
OR
term.UnimplementedException
- supportsProgramQuery()
is false
optional
- This method must be implemented if
supportsProgramQuery()
is true.
void clearProgramTerms()
mandatory
- This method must be implemented. void matchTermId(Id termId, boolean match)
Id
for this query to match program
offerings that have a related term.termId
- a term Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- termId
is
null
mandatory
- This method must be implemented. void clearTermIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsTermQuery()
TermQuery
is available. true
if a term query is available, false
otherwisemandatory
- This method must be implemented. TermQuery getTermQuery()
OR
term.UnimplementedException
- supportsTermQuery()
is false
optional
- This method must be implemented if
supportsTermQuery()
is true.
void clearTermTerms()
mandatory
- This method must be implemented. void matchTitle(java.lang.String title, Type stringMatchType, boolean match)
title
- title string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- title
not of
stringMatchType
NullArgumentException
- title
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyTitle(boolean match)
match
- true
to match program offerings with any
title, false
to match program offerings with no
titlemandatory
- This method must be implemented. void clearTitleTerms()
mandatory
- This method must be implemented. void matchNumber(java.lang.String number, Type stringMatchType, boolean match)
number
- program number string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- number
not of
stringMatchType
NullArgumentException
- number
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyNumber(boolean match)
match
- true
to match program offerings with any
number, false
to match program offerings with
no numbermandatory
- This method must be implemented. void clearNumberTerms()
mandatory
- This method must be implemented. void matchInstructorId(Id resourceId, boolean match)
Id
for this query to match program
offerings that have an instructor.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearInstructorIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsInstructorQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getInstructorQuery()
OR
term.UnimplementedException
-
supportsInstructorQuery()
is false
optional
- This method must be implemented if
supportsInstructorQuery()
is true.
void matchAnyInstructor(boolean match)
match
- true
to match program offerings with any
instructor, false
to match program offerings
with no instructorsmandatory
- This method must be implemented. void clearInstructorTerms()
mandatory
- This method must be implemented. void matchSponsorId(Id resourceId, boolean match)
Id
for this query to match programs
that have a sponsor.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearSponsorIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSponsorQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getSponsorQuery()
OR
term.UnimplementedException
- supportsSponsorQuery()
is false
optional
- This method must be implemented if
supportsSponsorQuery()
is true.
void matchAnySponsor(boolean match)
match
- true
to match programs with any sponsor,
false
to match programs with no sponsorsmandatory
- This method must be implemented. void clearSponsorTerms()
mandatory
- This method must be implemented. void matchCompletionRequirementsInfo(java.lang.String requirementsInfo, Type stringMatchType, boolean match)
requirementsInfo
- completion requirements string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- requirementsInfo
not of stringMatchType
NullArgumentException
- requirementsInfo
or stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyCompletionRequirementsInfo(boolean match)
match
- true
to match programs with any
completion requirements information, false
otherwisemandatory
- This method must be implemented. void clearCompletionRequirementsInfoTerms()
mandatory
- This method must be implemented. void matchCompletionRequirementsId(Id ruleId, boolean match)
Id
for this query.ruleId
- a rule Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- ruleId
is
null
mandatory
- This method must be implemented. void clearCompletionRequirementsIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCompletionRequirementsQuery()
RequisiteQuery
is available. true
if a requisite query is available,
false
otherwisemandatory
- This method must be implemented. RequisiteQuery getCompletionRequirementsQuery()
OR
term.UnimplementedException
-
supportsCompletionRequirementsQuery()
is false
optional
- This method must be implemented if
supportsCompletionRequirementsQuery()
is
true.
void matchAnyCompletionRequirements(boolean match)
match
- true
to match programs with any
requisite, false
to match programs with no
requisitesmandatory
- This method must be implemented. void clearCompletionRequirementsTerms()
mandatory
- This method must be implemented. void matchCredentialId(Id credentialId, boolean match)
Id
for this query.credentialId
- a credential Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- credentialId
is
null
mandatory
- This method must be implemented. void clearCredentialIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCredentialQuery()
CredentialQuery
is available. true
if a credential query is available,
false
otherwisemandatory
- This method must be implemented. CredentialQuery getCredentialQuery()
OR
term.UnimplementedException
-
supportsCredentialQuery()
is false
optional
- This method must be implemented if
supportsCredentialQuery()
is true.
void matchAnyCredential(boolean match)
match
- true
to match programs with any
credentials, false
to match programs with no
credentialsmandatory
- This method must be implemented. void clearCredentialTerms()
mandatory
- This method must be implemented. void matchRequiresRegistration(boolean match)
match
- true
to match program offerings requiring
registration,, false
to match program offerings
not requiring registrationmandatory
- This method must be implemented. void clearRequiresRegistrationTerms()
mandatory
- This method must be implemented. void matchMinimumSeats(long min, long max, boolean match)
min
- low numbermax
- high numbermatch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- max
is less
than min
mandatory
- This method must be implemented. void matchAnyMinimumSeats(boolean match)
match
- true
to match program offerings with any
minimum seats, false
to match program offerings
with no minimum seatsmandatory
- This method must be implemented. void clearMinimumSeatsTerms()
mandatory
- This method must be implemented. void matchMaximumSeats(long min, long max, boolean match)
min
- low numbermax
- high numbermatch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- max
is less
than min
mandatory
- This method must be implemented. void matchAnyMaximumSeats(boolean match)
match
- true
to match program offerings with any
maximum seats, false
to match program offerings
with no maximum seatsmandatory
- This method must be implemented. void clearMaximumSeatsTerms()
mandatory
- This method must be implemented. void matchURL(java.lang.String url, Type stringMatchType, boolean match)
url
- url string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- url
not of
stringMatchType
NullArgumentException
- url
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyURL(boolean match)
match
- true
to match program offerings with any
url, false
to match program offerings with no
urlmandatory
- This method must be implemented. void clearURLTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match
program offerings assigned to course catalogs.courseCatalogId
- the course catalog Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- courseCatalogId
is null
mandatory
- This method must be implemented. void clearCourseCatalogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseCatalogQuery()
CourseCatalogQuery
is available. true
if a course catalog query is available,
false
otherwisemandatory
- This method must be implemented. CourseCatalogQuery getCourseCatalogQuery()
OR
term.UnimplementedException
-
supportsCourseCatalogQuery()
is false
optional
- This method must be implemented if
supportsCourseCatalogQuery()
is true.
void clearCourseCatalogTerms()
mandatory
- This method must be implemented. ProgramOfferingQueryRecord getProgramOfferingQueryRecord(Type programOfferingRecordType) throws OperationFailedException
ProgramOffering
record Type.
Multiple
record retrievals produce a nested OR
term.programOfferingRecordType
- a program offering record typeNullArgumentException
-
programOfferingRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(programOfferingRecordType)
is
false
mandatory
- This method must be implemented.