org.osid.course.chronicle

Interface CredentialEntryQuery

All Superinterfaces:

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

public interface CredentialEntryQuery
extends OsidRelationshipQuery

This is the query for searching credential entries. 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	clearCredentialIdTerms() Clears the credential Id terms.
void	clearCredentialTerms() Clears the credential terms.
void	clearDateAwardedTerms() Clears the award date terms.
void	clearProgramIdTerms() Clears the program Id terms.
void	clearProgramTerms() Clears the program terms.
void	clearStudentIdTerms() Clears the student Id terms.
void	clearStudentTerms() Clears the student option terms.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
CredentialEntryQueryRecord	getCredentialEntryQueryRecord(Type credentialEntryRecordType) Gets the credential entry query record corresponding to the given CredentialEntry record Type.
CredentialQuery	getCredentialQuery() Gets the query for a credential entry.
ProgramQuery	getProgramQuery() Gets the query for a program.
ResourceQuery	getStudentQuery() Gets the query for a student option.
void	matchAnyDateAwarded(boolean match) Matches entries that have any award date.
void	matchAnyProgram(boolean match) Matches entries that have any program.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query to match entries assigned to course catalogs.
void	matchCredentialId(Id credentialId, boolean match) Sets the credential Id for this query to match entries that have an entry for the given course.
void	matchDateAwarded(DateTime from, DateTime to, boolean match) Matches award dates between the given dates inclusive.
void	matchProgramId(Id programId, boolean match) Sets the program Id for this query.
void	matchStudentId(Id resourceId, boolean match) Sets the student Id for this query.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsCredentialQuery() Tests if a CredentialQuery is available.
boolean	supportsProgramQuery() Tests if a ProgramQuery is available.
boolean	supportsStudentQuery() Tests if a StudentQuery 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

matchStudentId

void matchStudentId(Id resourceId,
                  boolean match)

Sets the student 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 Id terms.

Compliance:

mandatory - This method must be implemented.

supportsStudentQuery

boolean supportsStudentQuery()

Tests if a StudentQuery is available.

Returns:

true if a student query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentQuery

ResourceQuery getStudentQuery()

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

Returns:

a student query

Throws:

UnimplementedException - supportsStudentQuery() is false

Compliance:

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

clearStudentTerms

void clearStudentTerms()

Clears the student option terms.

Compliance:

mandatory - This method must be implemented.

matchCredentialId

void matchCredentialId(Id credentialId,
                     boolean match)

Sets the credential Id for this query to match entries that have an entry for the given course.

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

clearCredentialTerms

void clearCredentialTerms()

Clears the credential terms.

Compliance:

mandatory - This method must be implemented.

matchDateAwarded

void matchDateAwarded(DateTime from,
                    DateTime to,
                    boolean match)

Matches award dates between the given dates inclusive.

Parameters:

from - starting date

to - ending date

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyDateAwarded

void matchAnyDateAwarded(boolean match)

Matches entries that have any award date.

Parameters:

match - true to match entries with any award date, false to match entries with no award date

Compliance:

mandatory - This method must be implemented.

clearDateAwardedTerms

void clearDateAwardedTerms()

Clears the award date terms.

Compliance:

mandatory - This method must be implemented.

matchProgramId

void matchProgramId(Id programId,
                  boolean match)

Sets the program Id for this query.

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:

a program query

Throws:

UnimplementedException - supportsProgramQuery() is false

Compliance:

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

matchAnyProgram

void matchAnyProgram(boolean match)

Matches entries that have any program.

Parameters:

match - true to match entries with any program false to match entries with no program

Compliance:

mandatory - This method must be implemented.

clearProgramTerms

void clearProgramTerms()

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

getCredentialEntryQueryRecord

CredentialEntryQueryRecord getCredentialEntryQueryRecord(Type credentialEntryRecordType)
                                                         throws OperationFailedException

Gets the credential entry query record corresponding to the given CredentialEntry record Type. Multiple record retrievals produce a nested OR term.

Parameters:

credentialEntryRecordType - a credential entry record type

Returns:

the credential entry query record

Throws:

NullArgumentException - credentialEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.