org.osid.course.program

Interface CredentialQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface CredentialQueryInspector
extends OsidObjectQueryInspector

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.
CredentialQueryInspectorRecord	getCredentialQueryInspectorRecord(Type credentialRecordType) Gets the credential query inspector record corresponding to the given Credential record Type.
DurationRangeTerm[]	getLifetimeTerms() Gets the lifetime query terms.
IdTerm[]	getProgramIdTerms() Gets the program Id query terms.
ProgramQueryInspector[]	getProgramTerms() Gets the program query terms.

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

Method Detail

getLifetimeTerms

DurationRangeTerm[] getLifetimeTerms()

Gets the lifetime query terms.

Returns:

the query 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 query 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.

getCredentialQueryInspectorRecord

CredentialQueryInspectorRecord getCredentialQueryInspectorRecord(Type credentialRecordType)
                                                                 throws OperationFailedException

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

Throws:

NullArgumentException - credentialRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialRecordType) is false

Compliance:

mandatory - This method must be implemented.