OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.RealmQueryInspector
Implementsosid.OsidCatalogQueryInspector
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.

MethodgetPersonIdTerms
Description

Gets the person Id query terms.

Returnosid.search.terms.IdTerm[]the person Id terms
CompliancemandatoryThis method must be implemented.
MethodgetPersonTerms
Description

Gets the person query terms.

Returnosid.personnel.PersonQueryInspector[]the person terms
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationIdTerms
Description

Gets the organziation Id query terms.

Returnosid.search.terms.IdTerm[]the organziation Id terms
CompliancemandatoryThis method must be implemented.
MethodgetOrganizationTerms
Description

Gets the organziation query terms.

Returnosid.personnel.OrganizationQueryInspector[]the organziation terms
CompliancemandatoryThis method must be implemented.
MethodgetPositionIdTerms
Description

Gets the position Id query terms.

Returnosid.search.terms.IdTerm[]the position Id terms
CompliancemandatoryThis method must be implemented.
MethodgetPositionTerms
Description

Gets the position query terms.

Returnosid.personnel.PositionQueryInspector[]the position terms
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentIdTerms
Description

Gets the appointment Id query terms.

Returnosid.search.terms.IdTerm[]the appointment Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAppointmentTerms
Description

Gets the appointment query terms.

Returnosid.personnel.AppointmentQueryInspector[]the appointment terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorRealmIdTerms
Description

Gets the ancestor realm Id query terms.

Returnosid.search.terms.IdTerm[]the ancestor realm Id terms
CompliancemandatoryThis method must be implemented.
MethodgetAncestorRealmTerms
Description

Gets the ancestor realm query terms.

Returnosid.personnel.RealmQueryInspector[]the ancestor realm terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantRealmIdTerms
Description

Gets the descendant realm Id query terms.

Returnosid.search.terms.IdTerm[]the descendant realm Id terms
CompliancemandatoryThis method must be implemented.
MethodgetDescendantRealmTerms
Description

Gets the descendant realm query terms.

Returnosid.personnel.RealmQueryInspector[]the descendant realm terms
CompliancemandatoryThis method must be implemented.
MethodgetRealmQueryInspectorRecord
Description

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

Parametersosid.type.TyperealmRecordTypea realm record type
Returnosid.personnel.records.RealmQueryInspectorRecordthe realm query inspector record
ErrorsNULL_ARGUMENT realmRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(realmRecordType) is false
CompliancemandatoryThis method must be implemented.