Interface AppointmentQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
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
Modifier and TypeMethodDescriptiongetAppointmentQueryInspectorRecord(Type appointmentRecordType) Gets the appointment query inspector record corresponding to the givenAppointmentrecordType.Gets the commitment query terms.IdTerm[]Gets the personIdquery terms.Gets the person query terms.IdTerm[]Gets the positionIdquery terms.Gets the position query terms.IdTerm[]Gets the realmIdquery terms.Gets the realm query terms.Gets the salary query terms.Gets the title query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]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.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 subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidRelationshipQueryInspector
getEndReasonIdTerms, getEndReasonTermsModifier and TypeMethodDescriptionIdTerm[]Gets the end reaosn stateIdquery terms.Gets the end reaosn state query terms.Methods inherited from interface OsidTemporalQueryInspector
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.
-
Method Details
-
getPersonIdTerms
IdTerm[] getPersonIdTerms()Gets the personIdquery terms.- Returns:
- the person
Idterms - Compliance:
mandatory- This method must be implemented.
-
getPersonTerms
PersonQueryInspector[] getPersonTerms()Gets the person query terms.- Returns:
- the person terms
- Compliance:
mandatory- This method must be implemented.
-
getPositionIdTerms
IdTerm[] getPositionIdTerms()Gets the positionIdquery terms.- Returns:
- the position
Idterms - Compliance:
mandatory- This method must be implemented.
-
getPositionTerms
PositionQueryInspector[] getPositionTerms()Gets the position query terms.- Returns:
- the position terms
- Compliance:
mandatory- This method must be implemented.
-
getCommitmentTerms
CardinalRangeTerm[] getCommitmentTerms()Gets the commitment query terms.- Returns:
- the commitment terms
- Compliance:
mandatory- This method must be implemented.
-
getTitleTerms
StringTerm[] getTitleTerms()Gets the title query terms.- Returns:
- the title terms
- Compliance:
mandatory- This method must be implemented.
-
getSalaryTerms
CurrencyRangeTerm[] getSalaryTerms()Gets the salary query terms.- Returns:
- the salary terms
- Compliance:
mandatory- This method must be implemented.
-
getRealmIdTerms
IdTerm[] getRealmIdTerms()Gets the realmIdquery terms.- Returns:
- the realm
Idterms - Compliance:
mandatory- This method must be implemented.
-
getRealmTerms
RealmQueryInspector[] getRealmTerms()Gets the realm query terms.- Returns:
- the realm terms
- Compliance:
mandatory- This method must be implemented.
-
getAppointmentQueryInspectorRecord
AppointmentQueryInspectorRecord getAppointmentQueryInspectorRecord(Type appointmentRecordType) throws OperationFailedException Gets the appointment query inspector record corresponding to the givenAppointmentrecordType.- Parameters:
appointmentRecordType- an appointment record type- Returns:
- the appointment inspector query record
- Throws:
NullArgumentException-appointmentRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(appointmentRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-