org.osid.personnel

Interface PersonQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface PersonQueryInspector
extends OsidObjectQueryInspector

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
DateTimeRangeTerm[]	getBirthDateTerms() Gets the birth date query terms.
DateTimeRangeTerm[]	getDeathDateTerms() Gets the death date query terms.
StringTerm[]	getForenameAliasTerms() Gets the forename alias query terms.
StringTerm[]	getGenerationQualifierTerms() Gets the generation qualifier query terms.
StringTerm[]	getGivenNameTerms() Gets the given name query terms.
StringTerm[]	getInstitutionalIdentifierTerms() Gets the identifier query terms.
DateTimeRangeTerm[]	getLivingDateTerms() Gets the living date query terms.
StringTerm[]	getMiddleNameTerms() Gets the middle name query terms.
PersonQueryInspectorRecord	getPersonQueryInspectorRecord(Type personRecordType) Gets the person query inspector record corresponding to the given Person record Type.
StringTerm[]	getPreferredNameTerms() Gets the preferred name query terms.
StringTerm[]	getQualificationSuffixTerms() Gets the qualifier suffix query terms.
IdTerm[]	getRealmIdTerms() Gets the realm Id query terms.
RealmQueryInspector[]	getRealmTerms() Gets the realm query terms.
StringTerm[]	getSalutationTerms() Gets the salutation query terms.
StringTerm[]	getSurnameAliasTerms() Gets the surname alias query terms.
StringTerm[]	getSurnameTerms() Gets the surname query terms.

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

Method Detail

getSalutationTerms

StringTerm[] getSalutationTerms()

Gets the salutation query terms.

Returns:

the salutation terms

Compliance:

mandatory - This method must be implemented.

getGivenNameTerms

StringTerm[] getGivenNameTerms()

Gets the given name query terms.

Returns:

the given name terms

Compliance:

mandatory - This method must be implemented.

getPreferredNameTerms

StringTerm[] getPreferredNameTerms()

Gets the preferred name query terms.

Returns:

the preferred name terms

Compliance:

mandatory - This method must be implemented.

getForenameAliasTerms

StringTerm[] getForenameAliasTerms()

Gets the forename alias query terms.

Returns:

the forename alias terms

Compliance:

mandatory - This method must be implemented.

getMiddleNameTerms

StringTerm[] getMiddleNameTerms()

Gets the middle name query terms.

Returns:

the middle name terms

Compliance:

mandatory - This method must be implemented.

getSurnameTerms

StringTerm[] getSurnameTerms()

Gets the surname query terms.

Returns:

the surname terms

Compliance:

mandatory - This method must be implemented.

getSurnameAliasTerms

StringTerm[] getSurnameAliasTerms()

Gets the surname alias query terms.

Returns:

the surname alias terms

Compliance:

mandatory - This method must be implemented.

getGenerationQualifierTerms

StringTerm[] getGenerationQualifierTerms()

Gets the generation qualifier query terms.

Returns:

the generation qualifier terms

Compliance:

mandatory - This method must be implemented.

getQualificationSuffixTerms

StringTerm[] getQualificationSuffixTerms()

Gets the qualifier suffix query terms.

Returns:

the qualifier suffix terms

Compliance:

mandatory - This method must be implemented.

getBirthDateTerms

DateTimeRangeTerm[] getBirthDateTerms()

Gets the birth date query terms.

Returns:

the birth date terms

Compliance:

mandatory - This method must be implemented.

getDeathDateTerms

DateTimeRangeTerm[] getDeathDateTerms()

Gets the death date query terms.

Returns:

the death date terms

Compliance:

mandatory - This method must be implemented.

getLivingDateTerms

DateTimeRangeTerm[] getLivingDateTerms()

Gets the living date query terms.

Returns:

the living date terms

Compliance:

mandatory - This method must be implemented.

getInstitutionalIdentifierTerms

StringTerm[] getInstitutionalIdentifierTerms()

Gets the identifier query terms.

Returns:

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

getPersonQueryInspectorRecord

PersonQueryInspectorRecord getPersonQueryInspectorRecord(Type personRecordType)
                                                         throws OperationFailedException

Gets the person query inspector record corresponding to the given Person record Type.

Parameters:

personRecordType - a person record type

Returns:

the person inspector query record

Throws:

NullArgumentException - personRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(personRecordType) is false

Compliance:

mandatory - This method must be implemented.