org.osid.recognition

Interface ConvocationQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidGovernatorQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface ConvocationQueryInspector
extends OsidGovernatorQueryInspector

The inspector for examining convocation queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAcademyIdTerms() Gets the academy Id terms.
AcademyQueryInspector[]	getAcademyTerms() Gets the academy terms.
IdTerm[]	getAwardIdTerms() Gets the award Id terms.
AwardQueryInspector[]	getAwardTerms() Gets the award terms.
IdTerm[]	getConferralIdTerms() Gets the conferral Id terms.
ConferralQueryInspector[]	getConferralTerms() Gets the conferral terms.
ConvocationQueryInspectorRecord	getConvocationQueryInspectorRecord(Type convocationRecordType) Gets the convocation query inspector record corresponding to the given Convocation record Type.
DateTimeRangeTerm[]	getDateTerms() Gets the date terms.
IdTerm[]	getTimePeriodIdTerms() Gets the time period Id terms.
TimePeriodQueryInspector[]	getTimePeriodTerms() Gets the time period 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

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getAwardIdTerms

IdTerm[] getAwardIdTerms()

Gets the award Id terms.

Returns:

the award Id terms

Compliance:

mandatory - This method must be implemented.

getAwardTerms

AwardQueryInspector[] getAwardTerms()

Gets the award terms.

Returns:

the award terms

Compliance:

mandatory - This method must be implemented.

getDateTerms

DateTimeRangeTerm[] getDateTerms()

Gets the date terms.

Returns:

the date terms

Compliance:

mandatory - This method must be implemented.

getTimePeriodIdTerms

IdTerm[] getTimePeriodIdTerms()

Gets the time period Id terms.

Returns:

the time period Id terms

Compliance:

mandatory - This method must be implemented.

getTimePeriodTerms

TimePeriodQueryInspector[] getTimePeriodTerms()

Gets the time period terms.

Returns:

the time period terms

Compliance:

mandatory - This method must be implemented.

getConferralIdTerms

IdTerm[] getConferralIdTerms()

Gets the conferral Id terms.

Returns:

the conferral Id terms

Compliance:

mandatory - This method must be implemented.

getConferralTerms

ConferralQueryInspector[] getConferralTerms()

Gets the conferral terms.

Returns:

the conferral terms

Compliance:

mandatory - This method must be implemented.

getAcademyIdTerms

IdTerm[] getAcademyIdTerms()

Gets the academy Id terms.

Returns:

the academy Id terms

Compliance:

mandatory - This method must be implemented.

getAcademyTerms

AcademyQueryInspector[] getAcademyTerms()

Gets the academy terms.

Returns:

the academy terms

Compliance:

mandatory - This method must be implemented.

getConvocationQueryInspectorRecord

ConvocationQueryInspectorRecord getConvocationQueryInspectorRecord(Type convocationRecordType)
                                                                   throws OperationFailedException

Gets the convocation query inspector record corresponding to the given Convocation record Type.

Parameters:

convocationRecordType - a convocation record type

Returns:

the convocation query inspector record

Throws:

NullArgumentException - convocationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(convocationRecordType) is false

Compliance:

mandatory - This method must be implemented.