org.osid.offering

Interface ParticipantQueryInspector

All Superinterfaces:

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

public interface ParticipantQueryInspector
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[]	getCatalogueIdTerms() Gets the catalogue Id query terms.
CatalogueQueryInspector[]	getCatalogueTerms() Gets the catalogue query terms.
IdTerm[]	getOfferingIdTerms() Gets the offering Id query terms.
OfferingQueryInspector[]	getOfferingTerms() Gets the offering query terms.
ParticipantQueryInspectorRecord	getParticipantQueryInspectorRecord(Type participantRecordType) Gets the participant query inspector record corresponding to the given Participant record Type.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.
IdTerm[]	getResultOptionIdTerms() Gets the grade system Id query terms.
GradeSystemQueryInspector[]	getResultOptionTerms() Gets the grade system query terms.
IdTerm[]	getTimePeriodIdTerms() Gets the time period Id query terms.
TimePeriodQueryInspector[]	getTimePeriodTerms() Gets the time period 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

getOfferingIdTerms

IdTerm[] getOfferingIdTerms()

Gets the offering Id query terms.

Returns:

the offering Id terms

Compliance:

mandatory - This method must be implemented.

getOfferingTerms

OfferingQueryInspector[] getOfferingTerms()

Gets the offering query terms.

Returns:

the offering terms

Compliance:

mandatory - This method must be implemented.

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the resource Id terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource query terms.

Returns:

the resource terms

Compliance:

mandatory - This method must be implemented.

getTimePeriodIdTerms

IdTerm[] getTimePeriodIdTerms()

Gets the time period Id query terms.

Returns:

the time period Id query terms

Compliance:

mandatory - This method must be implemented.

getTimePeriodTerms

TimePeriodQueryInspector[] getTimePeriodTerms()

Gets the time period query terms.

Returns:

the time period query terms

Compliance:

mandatory - This method must be implemented.

getResultOptionIdTerms

IdTerm[] getResultOptionIdTerms()

Gets the grade system Id query terms.

Returns:

the grade system Id query terms

Compliance:

mandatory - This method must be implemented.

getResultOptionTerms

GradeSystemQueryInspector[] getResultOptionTerms()

Gets the grade system query terms.

Returns:

the grade system terms

Compliance:

mandatory - This method must be implemented.

getCatalogueIdTerms

IdTerm[] getCatalogueIdTerms()

Gets the catalogue Id query terms.

Returns:

the catalogue Id terms

Compliance:

mandatory - This method must be implemented.

getCatalogueTerms

CatalogueQueryInspector[] getCatalogueTerms()

Gets the catalogue query terms.

Returns:

the catalogue terms

Compliance:

mandatory - This method must be implemented.

getParticipantQueryInspectorRecord

ParticipantQueryInspectorRecord getParticipantQueryInspectorRecord(Type participantRecordType)
                                                                   throws OperationFailedException

Gets the participant query inspector record corresponding to the given Participant record Type.

Parameters:

participantRecordType - a participant record type

Returns:

the participant inspector query record

Throws:

NullArgumentException - participantRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(participantRecordType) is false

Compliance:

mandatory - This method must be implemented.