OSID - osid.personnel.RealmQueryInspector Service Interface Definition

Interface	osid.personnel.RealmQueryInspector
Implements	`osid.OsidCatalogQueryInspector`
Used By	`osid.personnel.AppointmentQueryInspector`
	`osid.personnel.OrganizationQueryInspector`
	`osid.personnel.PersonQueryInspector`
	`osid.personnel.PositionQueryInspector`
	`osid.personnel.RealmQueryInspector`
	`osid.personnel.RealmSearchResults`
Description	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. Like all `OsidQueryInspectors`, `RealmQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getPersonIdTerms
Description	Gets the person `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the person `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getPersonTerms
Description	Gets the person query terms.
Return	`osid.personnel.PersonQueryInspector[]`		the person terms
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationIdTerms
Description	Gets the organziation `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the organziation `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationTerms
Description	Gets the organziation query terms.
Return	`osid.personnel.OrganizationQueryInspector[]`		the organziation terms
Compliance	`mandatory`		This method must be implemented.
Method	getPositionIdTerms
Description	Gets the position `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the position `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getPositionTerms
Description	Gets the position query terms.
Return	`osid.personnel.PositionQueryInspector[]`		the position terms
Compliance	`mandatory`		This method must be implemented.
Method	getAppointmentIdTerms
Description	Gets the appointment `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the appointment `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getAppointmentTerms
Description	Gets the appointment query terms.
Return	`osid.personnel.AppointmentQueryInspector[]`		the appointment terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorRealmIdTerms
Description	Gets the ancestor realm `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the ancestor realm `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorRealmTerms
Description	Gets the ancestor realm query terms.
Return	`osid.personnel.RealmQueryInspector[]`		the ancestor realm terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantRealmIdTerms
Description	Gets the descendant realm `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the descendant realm `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantRealmTerms
Description	Gets the descendant realm query terms.
Return	`osid.personnel.RealmQueryInspector[]`		the descendant realm terms
Compliance	`mandatory`		This method must be implemented.
Method	getRealmQueryInspectorRecord
Description	Gets the record query inspector record corresponding to the given `Realm` record `Type`.
Parameters	`osid.type.Type`	`realmRecordType`	a realm record type
Return	`osid.personnel.records.RealmQueryInspectorRecord`		the realm query inspector record
Errors	NULL_ARGUMENT		`realmRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(realmRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.