Class AbstractParticipantQueryInspector
java.lang.Object
net.okapia.osid.jamocha.spi.AbstractOsidQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidIdentifiableQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidObjectQueryInspector
net.okapia.osid.jamocha.spi.AbstractTemporalOsidObjectQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidRelationshipQueryInspector
net.okapia.osid.jamocha.offering.participant.spi.AbstractParticipantQueryInspector
- All Implemented Interfaces:
Extensible, ParticipantQueryInspector, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
- Direct Known Subclasses:
ParticipantQueryUninspector
public abstract class AbstractParticipantQueryInspector
extends AbstractOsidRelationshipQueryInspector
implements ParticipantQueryInspector
A query inspector template for participants.
-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractTemporalOsidObjectQueryInspector
AbstractTemporalOsidObjectQueryInspector.OsidTemporalQueryInspectorModifier and TypeClassDescriptionprotected classComposed OsidTemporalQueryInspector.Nested classes/interfaces inherited from class AbstractOsidObjectQueryInspector
AbstractOsidObjectQueryInspector.OsidBrowsableQueryInspectorModifier and TypeClassDescriptionprotected classComposed BrowsableQueryInspector. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newAbstractParticipantQueryInspector. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddParticipantQueryInspectorRecord(ParticipantQueryInspectorRecord participantQueryInspectorRecord, Type participantRecordType) Adds a record to this participant query.IdTerm[]Gets the catalogueIdquery terms.Gets the catalogue query terms.IdTerm[]Gets the offeringIdquery terms.Gets the offering query terms.getParticipantQueryInspectorRecord(Type participantRecordType) Gets the record corresponding to the given participant query inspector recordType.IdTerm[]Gets the resourceIdquery terms.Gets the resource query terms.IdTerm[]Gets the grade systemIdquery terms.Gets the grade system query terms.IdTerm[]Gets the time periodIdquery terms.Gets the time period query terms.Methods inherited from class AbstractOsidRelationshipQueryInspector
getEndReasonIdTerms, getEndReasonTermsModifier and TypeMethodDescriptionIdTerm[]Gets the end reaosn stateIdquery terms.Gets the end reason state query terms.Methods inherited from class AbstractTemporalOsidObjectQueryInspector
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTermsModifier and TypeMethodDescriptionGets the date query terms.Gets the effective query terms.Gets the end date query terms.Gets the start date query terms.Methods inherited from class AbstractOsidObjectQueryInspector
addRecordType, getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRecordTypes, getRecordTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms, hasRecordTypeModifier and TypeMethodDescriptionprotected voidaddRecordType(Type recordType) Adds a record type.IdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.Gets the record types available in this object.TypeTerm[]Gets the record type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the relevancy query terms.Gets the subject query terms.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from class AbstractOsidIdentifiableQueryInspector
getIdTermsMethods inherited from class AbstractOsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Constructor Details
-
AbstractParticipantQueryInspector
public AbstractParticipantQueryInspector()Constructs a newAbstractParticipantQueryInspector.
-
-
Method Details
-
getOfferingIdTerms
Gets the offeringIdquery terms.- Specified by:
getOfferingIdTermsin interfaceParticipantQueryInspector- Returns:
- the offering
Idterms
-
getOfferingTerms
Gets the offering query terms.- Specified by:
getOfferingTermsin interfaceParticipantQueryInspector- Returns:
- the offering terms
-
getResourceIdTerms
Gets the resourceIdquery terms.- Specified by:
getResourceIdTermsin interfaceParticipantQueryInspector- Returns:
- the resource
Idterms
-
getResourceTerms
Gets the resource query terms.- Specified by:
getResourceTermsin interfaceParticipantQueryInspector- Returns:
- the resource terms
-
getTimePeriodIdTerms
Gets the time periodIdquery terms.- Specified by:
getTimePeriodIdTermsin interfaceParticipantQueryInspector- Returns:
- the time period
Idquery terms
-
getTimePeriodTerms
Gets the time period query terms.- Specified by:
getTimePeriodTermsin interfaceParticipantQueryInspector- Returns:
- the time period query terms
-
getResultOptionIdTerms
Gets the grade systemIdquery terms.- Specified by:
getResultOptionIdTermsin interfaceParticipantQueryInspector- Returns:
- the grade system
Idquery terms
-
getResultOptionTerms
Gets the grade system query terms.- Specified by:
getResultOptionTermsin interfaceParticipantQueryInspector- Returns:
- the grade system terms
-
getCatalogueIdTerms
Gets the catalogueIdquery terms.- Specified by:
getCatalogueIdTermsin interfaceParticipantQueryInspector- Returns:
- the catalogue
Idterms
-
getCatalogueTerms
Gets the catalogue query terms.- Specified by:
getCatalogueTermsin interfaceParticipantQueryInspector- Returns:
- the catalogue terms
-
getParticipantQueryInspectorRecord
@OSID public ParticipantQueryInspectorRecord getParticipantQueryInspectorRecord(Type participantRecordType) throws OperationFailedException Gets the record corresponding to the given participant query inspector recordType.This method must be used to retrieve a participant implementing the requested record.- Specified by:
getParticipantQueryInspectorRecordin interfaceParticipantQueryInspector- Parameters:
participantRecordType- a participant record type- Returns:
- the participant query inspsector record
- Throws:
NullArgumentException-participantRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(participantRecordType)isfalse
-
addParticipantQueryInspectorRecord
protected void addParticipantQueryInspectorRecord(ParticipantQueryInspectorRecord participantQueryInspectorRecord, Type participantRecordType) Adds a record to this participant query.- Parameters:
participantQueryInspectorRecord- participant query inspector recordparticipantRecordType- participant record type- Throws:
NullArgumentException-recordisnull
-