org.osid.personnel

Interface AppointmentQueryInspector

All Superinterfaces:

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

public interface AppointmentQueryInspector
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
AppointmentQueryInspectorRecord	getAppointmentQueryInspectorRecord(Type appointmentRecordType) Gets the appointment query inspector record corresponding to the given Appointment record Type.
CardinalRangeTerm[]	getCommitmentTerms() Gets the commitment query terms.
IdTerm[]	getPersonIdTerms() Gets the person Id query terms.
PersonQueryInspector[]	getPersonTerms() Gets the person query terms.
IdTerm[]	getPositionIdTerms() Gets the position Id query terms.
PositionQueryInspector[]	getPositionTerms() Gets the position query terms.
IdTerm[]	getRealmIdTerms() Gets the realm Id query terms.
RealmQueryInspector[]	getRealmTerms() Gets the realm query terms.
CurrencyRangeTerm[]	getSalaryTerms() Gets the salary query terms.
StringTerm[]	getTitleTerms() Gets the title 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

getPersonIdTerms

IdTerm[] getPersonIdTerms()

Gets the person Id query terms.

Returns:

the person Id terms

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 position Id query terms.

Returns:

the position Id terms

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 realm Id query terms.

Returns:

the realm Id terms

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 given Appointment record Type.

Parameters:

appointmentRecordType - an appointment record type

Returns:

the appointment inspector query record

Throws:

NullArgumentException - appointmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(appointmentRecordType) is false

Compliance:

mandatory - This method must be implemented.