org.osid.course.program

Interface ProgramQuery

All Superinterfaces:

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

public interface ProgramQuery
extends OsidObjectQuery, OsidOperableQuery

This is the query for searching programs. 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	clearNumberTerms() Clears the number terms.
void	clearProgramOfferingIdTerms() Clears the program offering Id terms.
void	clearProgramOfferingTerms() Clears the program offering terms.
void	clearSponsorIdTerms() Clears the sponsor Id terms.
void	clearSponsorTerms() Clears the sponsor terms.
void	clearTitleTerms() Clears the title 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.
ProgramOfferingQuery	getProgramOfferingQuery() Gets the query for a program offering.
ProgramQueryRecord	getProgramQueryRecord(Type programRecordType) Gets the program query record corresponding to the given Program record Type.
ResourceQuery	getSponsorQuery() Gets the query for a sponsor.
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	matchAnyNumber(boolean match) Matches a programs number that has any value.
void	matchAnyProgramOffering(boolean match) Matches programs that have any program offering.
void	matchAnySponsor(boolean match) Matches programs that have any sponsor.
void	matchAnyTitle(boolean match) Matches a title 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 programs assigned to course catalogs.
void	matchCredentialId(Id credentialId, boolean match) Sets the credential Id for this query.
void	matchNumber(java.lang.String number, Type stringMatchType, boolean match) Adds a programs number for this query.
void	matchProgramOfferingId(Id programOfferingId, boolean match) Sets the program offering Id for this query to match programs that have a related program offering.
void	matchSponsorId(Id resourceId, boolean match) Sets the resource Id for this query to match programs that have a sponsor.
void	matchTitle(java.lang.String title, Type stringMatchType, boolean match) Adds a title 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	supportsProgramOfferingQuery() Tests if a ProgramOfferingQuery is available.
boolean	supportsSponsorQuery() Tests if a ResourceQuery 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

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

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 programs with any title, false to match programs 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 programs number for this query.

Parameters:

number - programs 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 programs number that has any value.

Parameters:

match - true to match programs with any number, false to match programs with no title

Compliance:

mandatory - This method must be implemented.

clearNumberTerms

void clearNumberTerms()

Clears the number 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.

matchProgramOfferingId

void matchProgramOfferingId(Id programOfferingId,
                          boolean match)

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

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

matchAnyProgramOffering

void matchAnyProgramOffering(boolean match)

Matches programs that have any program offering.

Parameters:

match - true to match programs with any program offering, false to match programs with no program offering

Compliance:

mandatory - This method must be implemented.

clearProgramOfferingTerms

void clearProgramOfferingTerms()

Clears the program offering 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 programs 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.

getProgramQueryRecord

ProgramQueryRecord getProgramQueryRecord(Type programRecordType)
                                         throws OperationFailedException

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

Parameters:

programRecordType - a programs record type

Returns:

the program query record

Throws:

NullArgumentException - programRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programRecordType) is false

Compliance:

mandatory - This method must be implemented.