org.osid.course.chronicle

Interface CredentialEntryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface CredentialEntryQueryInspector
extends OsidRelationshipQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getCourseCatalogIdTerms() Gets the course catalog Id query terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms() Gets the course catalog query terms.
CredentialEntryQueryInspectorRecord	getCredentialEntryQueryInspectorRecord(Type credentialEntryRecordType) Gets the credential entry query inspector record corresponding to the given CredentialEntry record Type.
IdTerm[]	getCredentialIdTerms() Gets the credential Id query terms.
CredentialQueryInspector[]	getCredentialTerms() Gets the credential query terms.
DateTimeRangeTerm[]	getDateAwardedTerms() Gets the award date query terms.
IdTerm[]	getProgramIdTerms() Gets the program Id query terms.
ProgramQueryInspector[]	getProgramTerms() Gets the program query terms.
IdTerm[]	getStudentIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getStudentTerms() Gets the student query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getStudentIdTerms

IdTerm[] getStudentIdTerms()

Gets the resource Id query terms.

Returns:

the resource Id query terms

Compliance:

mandatory - This method must be implemented.

getStudentTerms

ResourceQueryInspector[] getStudentTerms()

Gets the student query terms.

Returns:

the resource query terms

Compliance:

mandatory - This method must be implemented.

getCredentialIdTerms

IdTerm[] getCredentialIdTerms()

Gets the credential Id query terms.

Returns:

the credential Id query terms

Compliance:

mandatory - This method must be implemented.

getCredentialTerms

CredentialQueryInspector[] getCredentialTerms()

Gets the credential query terms.

Returns:

the credential terms

Compliance:

mandatory - This method must be implemented.

getDateAwardedTerms

DateTimeRangeTerm[] getDateAwardedTerms()

Gets the award date query terms.

Returns:

the date terms

Compliance:

mandatory - This method must be implemented.

getProgramIdTerms

IdTerm[] getProgramIdTerms()

Gets the program Id query terms.

Returns:

the program Id query terms

Compliance:

mandatory - This method must be implemented.

getProgramTerms

ProgramQueryInspector[] getProgramTerms()

Gets the program query terms.

Returns:

the program terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdTerms

IdTerm[] getCourseCatalogIdTerms()

Gets the course catalog Id query terms.

Returns:

the course catalog Id query terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogTerms

CourseCatalogQueryInspector[] getCourseCatalogTerms()

Gets the course catalog query terms.

Returns:

the course catalog query terms

Compliance:

mandatory - This method must be implemented.

getCredentialEntryQueryInspectorRecord

CredentialEntryQueryInspectorRecord getCredentialEntryQueryInspectorRecord(Type credentialEntryRecordType)
                                                                           throws OperationFailedException

Gets the credential entry query inspector 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 inspector record

Throws:

NullArgumentException - credentialEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.