org.osid.personnel

Interface RealmQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface RealmQueryInspector
extends OsidCatalogQueryInspector

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[]	getAncestorRealmIdTerms() Gets the ancestor realm Id query terms.
RealmQueryInspector[]	getAncestorRealmTerms() Gets the ancestor realm query terms.
IdTerm[]	getAppointmentIdTerms() Gets the appointment Id query terms.
AppointmentQueryInspector[]	getAppointmentTerms() Gets the appointment query terms.
IdTerm[]	getDescendantRealmIdTerms() Gets the descendant realm Id query terms.
RealmQueryInspector[]	getDescendantRealmTerms() Gets the descendant realm query terms.
IdTerm[]	getOrganizationIdTerms() Gets the organziation Id query terms.
OrganizationQueryInspector[]	getOrganizationTerms() Gets the organziation 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.
RealmQueryInspectorRecord	getRealmQueryInspectorRecord(Type realmRecordType) Gets the record query inspector record corresponding to the given Realm record Type.

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.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

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.

getOrganizationIdTerms

IdTerm[] getOrganizationIdTerms()

Gets the organziation Id query terms.

Returns:

the organziation Id terms

Compliance:

mandatory - This method must be implemented.

getOrganizationTerms

OrganizationQueryInspector[] getOrganizationTerms()

Gets the organziation query terms.

Returns:

the organziation 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.

getAppointmentIdTerms

IdTerm[] getAppointmentIdTerms()

Gets the appointment Id query terms.

Returns:

the appointment Id terms

Compliance:

mandatory - This method must be implemented.

getAppointmentTerms

AppointmentQueryInspector[] getAppointmentTerms()

Gets the appointment query terms.

Returns:

the appointment terms

Compliance:

mandatory - This method must be implemented.

getAncestorRealmIdTerms

IdTerm[] getAncestorRealmIdTerms()

Gets the ancestor realm Id query terms.

Returns:

the ancestor realm Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorRealmTerms

RealmQueryInspector[] getAncestorRealmTerms()

Gets the ancestor realm query terms.

Returns:

the ancestor realm terms

Compliance:

mandatory - This method must be implemented.

getDescendantRealmIdTerms

IdTerm[] getDescendantRealmIdTerms()

Gets the descendant realm Id query terms.

Returns:

the descendant realm Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantRealmTerms

RealmQueryInspector[] getDescendantRealmTerms()

Gets the descendant realm query terms.

Returns:

the descendant realm terms

Compliance:

mandatory - This method must be implemented.

getRealmQueryInspectorRecord

RealmQueryInspectorRecord getRealmQueryInspectorRecord(Type realmRecordType)
                                                       throws OperationFailedException

Gets the record query inspector record corresponding to the given Realm record Type.

Parameters:

realmRecordType - a realm record type

Returns:

the realm query inspector record

Throws:

NullArgumentException - realmRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(realmRecordType) is false

Compliance:

mandatory - This method must be implemented.