OSID Specifications
personnel package
Version 3.1.0
personnel package
Version 3.1.0
| Interface | osid.personnel.PersonQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Used By | osid.personnel.AppointmentQueryInspector | ||
osid.personnel.PersonSearchResults | |||
osid.personnel.PersonSmartRealmSession | |||
osid.personnel.RealmQueryInspector | |||
| 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
| ||
| Method | getSalutationTerms | ||
| Description |
Gets the salutation query terms. | ||
| Return | osid.search.terms.StringTerm[] | the salutation terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGivenNameTerms | ||
| Description |
Gets the given name query terms. | ||
| Return | osid.search.terms.StringTerm[] | the given name terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPreferredNameTerms | ||
| Description |
Gets the preferred name query terms. | ||
| Return | osid.search.terms.StringTerm[] | the preferred name terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getForenameAliasTerms | ||
| Description |
Gets the forename alias query terms. | ||
| Return | osid.search.terms.StringTerm[] | the forename alias terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMiddleNameTerms | ||
| Description |
Gets the middle name query terms. | ||
| Return | osid.search.terms.StringTerm[] | the middle name terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSurnameTerms | ||
| Description |
Gets the surname query terms. | ||
| Return | osid.search.terms.StringTerm[] | the surname terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSurnameAliasTerms | ||
| Description |
Gets the surname alias query terms. | ||
| Return | osid.search.terms.StringTerm[] | the surname alias terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGenerationQualifierTerms | ||
| Description |
Gets the generation qualifier query terms. | ||
| Return | osid.search.terms.StringTerm[] | the generation qualifier terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQualificationSuffixTerms | ||
| Description |
Gets the qualifier suffix query terms. | ||
| Return | osid.search.terms.StringTerm[] | the qualifier suffix terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBirthDateTerms | ||
| Description |
Gets the birth date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the birth date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDeathDateTerms | ||
| Description |
Gets the death date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the death date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLivingDateTerms | ||
| Description |
Gets the living date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the living date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInstitutionalIdentifierTerms | ||
| Description |
Gets the identifier query terms. | ||
| Return | osid.search.terms.StringTerm[] | the identifier terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRealmIdTerms | ||
| Description |
Gets the realm | ||
| Return | osid.search.terms.IdTerm[] | the realm Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRealmTerms | ||
| Description |
Gets the realm query terms. | ||
| Return | osid.personnel.RealmQueryInspector[] | the realm terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPersonQueryInspectorRecord | ||
| Description |
Gets the person query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | personRecordType | a person record type |
| Return | osid.personnel.records.PersonQueryInspectorRecord | the person inspector query record | |
| Errors | NULL_ARGUMENT | personRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(personRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |