org.osid.course.chronicle

Interface AwardEntryQueryInspector

All Superinterfaces:

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

public interface AwardEntryQueryInspector
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[]	getAssessmentIdTerms() Gets the assessment Id query terms.
CourseQueryInspector[]	getAssessmentTerms() Gets the assessment query terms.
AwardEntryQueryInspectorRecord	getAwardEntryQueryInspectorRecord(Type awardEntryRecordType) Gets the award entry query inspector record corresponding to the given AwardEntry record Type.
IdTerm[]	getAwardIdTerms() Gets the award Id query terms.
AwardQueryInspector[]	getAwardTerms() Gets the award query terms.
IdTerm[]	getCourseCatalogIdTerms() Gets the course catalog Id query terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms() Gets the course catalog query terms.
IdTerm[]	getCourseIdTerms() Gets the course Id query terms.
CourseQueryInspector[]	getCourseTerms() Gets the course 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.

getAwardIdTerms

IdTerm[] getAwardIdTerms()

Gets the award Id query terms.

Returns:

the award Id query terms

Compliance:

mandatory - This method must be implemented.

getAwardTerms

AwardQueryInspector[] getAwardTerms()

Gets the award query terms.

Returns:

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

getCourseIdTerms

IdTerm[] getCourseIdTerms()

Gets the course Id query terms.

Returns:

the course Id query terms

Compliance:

mandatory - This method must be implemented.

getCourseTerms

CourseQueryInspector[] getCourseTerms()

Gets the course query terms.

Returns:

the course terms

Compliance:

mandatory - This method must be implemented.

getAssessmentIdTerms

IdTerm[] getAssessmentIdTerms()

Gets the assessment Id query terms.

Returns:

the assessment Id query terms

Compliance:

mandatory - This method must be implemented.

getAssessmentTerms

CourseQueryInspector[] getAssessmentTerms()

Gets the assessment query terms.

Returns:

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

getAwardEntryQueryInspectorRecord

AwardEntryQueryInspectorRecord getAwardEntryQueryInspectorRecord(Type awardEntryRecordType)
                                                                 throws OperationFailedException

Gets the award entry query inspector record corresponding to the given AwardEntry record Type. Multiple record retrievals produce a nested OR term.

Parameters:

awardEntryRecordType - an award entry record type

Returns:

the award entry query inspector record

Throws:

NullArgumentException - awardEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.