org.osid.course.program

Interface CredentialQuery

All Superinterfaces:

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

public interface CredentialQuery
extends OsidObjectQuery

This is the query for searching credentials. 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	clearLifetimeTerms() Clears the lifetime Id terms.
void	clearProgramIdTerms() Clears the program Id terms.
void	clearProgramTerms() Clears the program terms.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
CredentialQueryRecord	getCredentialQueryRecord(Type credentialRecordType) Gets the credential query record corresponding to the given Credential record Type.
ProgramQuery	getProgramQuery() Gets the query for a program.
void	matchAnyLifetime(boolean match) Matches credentials that have any lifetime.
void	matchAnyProgram(boolean match) Matches credentials that have any program.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query to match credentials assigned to course catalogs.
void	matchLifetime(Duration low, Duration high, boolean match) Matches lifetimes between the given range inclusive.
void	matchProgramId(Id programId, boolean match) Sets the program Id for this query to match credentials that have a related program.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsProgramQuery() Tests if a ProgramQuery 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

Method Detail

matchLifetime

void matchLifetime(Duration low,
                 Duration high,
                 boolean match)

Matches lifetimes between the given range inclusive.

Parameters:

low - start of range

high - end of range

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

Throws:

InvalidArgumentException - low is greater than high

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

matchAnyLifetime

void matchAnyLifetime(boolean match)

Matches credentials that have any lifetime.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearLifetimeTerms

void clearLifetimeTerms()

Clears the lifetime Id terms.

Compliance:

mandatory - This method must be implemented.

matchProgramId

void matchProgramId(Id programId,
                  boolean match)

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

matchAnyProgram

void matchAnyProgram(boolean match)

Matches credentials that have any program.

Parameters:

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

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

getCredentialQueryRecord

CredentialQueryRecord getCredentialQueryRecord(Type credentialRecordType)
                                               throws OperationFailedException

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

Parameters:

credentialRecordType - a credential record type

Returns:

the credential query record

Throws:

NullArgumentException - credentialRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialRecordType) is false

Compliance:

mandatory - This method must be implemented.