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.
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. |
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 matchStudentId(Id resourceId, boolean match)
Id
for this query.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 clearStudentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsStudentQuery()
StudentQuery
is available. true
if a student query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getStudentQuery()
OR
term.UnimplementedException
- supportsStudentQuery()
is false
optional
- This method must be implemented if
supportsStudentQuery()
is true.
void clearStudentTerms()
mandatory
- This method must be implemented. void matchCredentialId(Id credentialId, boolean match)
Id
for this query to match entries
that have an entry for the given course.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 clearCredentialTerms()
mandatory
- This method must be implemented. void matchDateAwarded(DateTime from, DateTime to, boolean match)
from
- starting dateto
- ending datematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyDateAwarded(boolean match)
match
- true
to match entries with any award
date, false
to match entries with no award datemandatory
- This method must be implemented. void clearDateAwardedTerms()
mandatory
- This method must be implemented. void matchProgramId(Id programId, boolean match)
Id
for this query.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 matchAnyProgram(boolean match)
match
- true
to match entries with any program
false
to match entries with no programmandatory
- This method must be implemented. void clearProgramTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match
entries 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. CredentialEntryQueryRecord getCredentialEntryQueryRecord(Type credentialEntryRecordType) throws OperationFailedException
CredentialEntry
record Type.
Multiple
record retrievals produce a nested OR
term.credentialEntryRecordType
- a credential entry record typeNullArgumentException
-
credentialEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(credentialEntryRecordType)
is
false
mandatory
- This method must be implemented.