Interface PersonQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface PersonQuery
extends OsidObjectQuery

This is the query for searching persons. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearBirthDateTerms()	Clears all birth date terms.
void	clearDeathDateTerms()	Clears all death date terms.
void	clearForenameAliasTerms()	Clears all forename alias terms.
void	clearGenerationQualifierTerms()	Clears all generation qualifier terms.
void	clearGivenNameTerms()	Clears all given name terms.
void	clearInstitutionalIdentifierTerms()	Clears all institutional identifier terms.
void	clearLivingDateTerms()	Clears all living date terms.
void	clearMiddleNameTerms()	Clears all middle name terms.
void	clearPreferredNameTerms()	Clears all preferred name terms.
void	clearQualificationSuffixTerms()	Clears all qualification suffix terms.
void	clearRealmIdTerms()	Clears all realm Id terms.
void	clearRealmTerms()	Clears all realm terms.
void	clearSalutationTerms()	Clears all salutation terms.
void	clearSurnameAliasTerms()	Clears all surname alias terms.
void	clearSurnameTerms()	Clears all surname terms.
PersonQueryRecord	getPersonQueryRecord(Type personRecordType)	Gets the person query record corresponding to the given Person record Type .Multiple record retrievals produce a nested OR term.
RealmQuery	getRealmQuery()	Gets the query for a realm query.
void	matchAnyBirthDate(boolean match)	Matches persons with any birth date.
void	matchAnyDeathDate(boolean match)	Matches persons with any death date.
void	matchAnyForenameAlias(boolean match)	Matches persons with any forename alias.
void	matchAnyGenerationQualifier(boolean match)	Matches persons with any generation qualifier.
void	matchAnyGivenName(boolean match)	Matches persons with any given name.
void	matchAnyInstitutionalIdentifier(boolean match)	Matches persons with any institutional identifier.
void	matchAnyMiddleName(boolean match)	Matches persons with any middle name.
void	matchAnyPreferredName(boolean match)	Matches persons with any preferred name.
void	matchAnyQualificationSuffix(boolean match)	Matches persons with any qualification suffix.
void	matchAnySalutation(boolean match)	Matches persons with any salutation.
void	matchAnySurname(boolean match)	Matches persons with any surname.
void	matchAnySurnameAlias(boolean match)	Matches persons with any surname alias.
void	matchBirthDate(DateTime from, DateTime to, boolean match)	Matches a birth date bwteen the given range inclusive.
void	matchDeathDate(DateTime from, DateTime to, boolean match)	Matches a death date between the given range inclusive.
void	matchForenameAlias(String forenameAlias, Type stringMatchType, boolean match)	Matches a forename alias.
void	matchGenerationQualifier(String generationQualifier, Type stringMatchType, boolean match)	Matches a generation qualifier.
void	matchGivenName(String givenName, Type stringMatchType, boolean match)	Matches a given name.
void	matchInstitutionalIdentifier(String identifier, Type stringMatchType, boolean match)	Matches an institutional identifier.
void	matchLivingDate(DateTime from, DateTime to, boolean match)	Matches a persons alive within the given dates inclusive.
void	matchMiddleName(String middleName, Type stringMatchType, boolean match)	Matches a middle name.
void	matchPreferredName(String preferredName, Type stringMatchType, boolean match)	Matches a preferred name.
void	matchQualificationSuffix(String qualificationSuffix, Type stringMatchType, boolean match)	Matches a qualification suffix.
void	matchRealmId(Id realmId, boolean match)	Sets the realm Id for this query to match persons assigned to realms.
void	matchSalutation(String salutation, Type stringMatchType, boolean match)	Matches a salutation.
void	matchSurname(String surname, Type stringMatchType, boolean match)	Matches a surname.
void	matchSurnameAlias(String surnameAlias, Type stringMatchType, boolean match)	Matches a surname alias.
boolean	supportsRealmQuery()	Tests if a RealmQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchSalutation

void matchSalutation(String salutation,
 Type stringMatchType,
 boolean match)

Matches a salutation.

Parameters:

salutation - a salutation

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - salutation is not of stringMatchType

NullArgumentException - salutation or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnySalutation

void matchAnySalutation(boolean match)

Matches persons with any salutation.

Parameters:

match - true to match persons with any salutation, false to match persons with no salutation

Compliance:

mandatory - This method must be implemented.

clearSalutationTerms

void clearSalutationTerms()

Clears all salutation terms.

Compliance:

mandatory - This method must be implemented.

matchGivenName

void matchGivenName(String givenName,
 Type stringMatchType,
 boolean match)

Matches a given name.

Parameters:

givenName - a given name

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - givenName is not of stringMatchType

NullArgumentException - givenName or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyGivenName

void matchAnyGivenName(boolean match)

Matches persons with any given name.

Parameters:

match - true to match persons with any given name, false to match persons with no given name

Compliance:

mandatory - This method must be implemented.

clearGivenNameTerms

void clearGivenNameTerms()

Clears all given name terms.

Compliance:

mandatory - This method must be implemented.

matchPreferredName

void matchPreferredName(String preferredName,
 Type stringMatchType,
 boolean match)

Matches a preferred name.

Parameters:

preferredName - a preferred name

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - preferredName is not of stringMatchType

NullArgumentException - preferredName or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyPreferredName

void matchAnyPreferredName(boolean match)

Matches persons with any preferred name.

Parameters:

match - true to match persons with any preferred name, false to match persons with no preferred name

Compliance:

mandatory - This method must be implemented.

clearPreferredNameTerms

void clearPreferredNameTerms()

Clears all preferred name terms.

Compliance:

mandatory - This method must be implemented.

matchForenameAlias

void matchForenameAlias(String forenameAlias,
 Type stringMatchType,
 boolean match)

Matches a forename alias.

Parameters:

forenameAlias - a forename alias

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - forenameAlias is not of stringMatchType

NullArgumentException - forenameAlias or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyForenameAlias

void matchAnyForenameAlias(boolean match)

Matches persons with any forename alias.

Parameters:

match - true to match persons with any forename alias, false to match persons with no forename aliases

Compliance:

mandatory - This method must be implemented.

clearForenameAliasTerms

void clearForenameAliasTerms()

Clears all forename alias terms.

Compliance:

mandatory - This method must be implemented.

matchMiddleName

void matchMiddleName(String middleName,
 Type stringMatchType,
 boolean match)

Matches a middle name.

Parameters:

middleName - a middle name

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - middleName is not of stringMatchType

NullArgumentException - middleName or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyMiddleName

void matchAnyMiddleName(boolean match)

Matches persons with any middle name.

Parameters:

match - true to match persons with any middle name, false to match persons with no middle name

Compliance:

mandatory - This method must be implemented.

clearMiddleNameTerms

void clearMiddleNameTerms()

Clears all middle name terms.

Compliance:

mandatory - This method must be implemented.

matchSurname

void matchSurname(String surname,
 Type stringMatchType,
 boolean match)

Matches a surname.

Parameters:

surname - a surname

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - surName is not of stringMatchType

NullArgumentException - surName or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnySurname

void matchAnySurname(boolean match)

Matches persons with any surname.

Parameters:

match - true to match persons with any surname, false to match persons with no surname

Compliance:

mandatory - This method must be implemented.

clearSurnameTerms

void clearSurnameTerms()

Clears all surname terms.

Compliance:

mandatory - This method must be implemented.

matchSurnameAlias

void matchSurnameAlias(String surnameAlias,
 Type stringMatchType,
 boolean match)

Matches a surname alias.

Parameters:

surnameAlias - a surname alias

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - surnameAlias is not of stringMatchType

NullArgumentException - surnameAlias or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnySurnameAlias

void matchAnySurnameAlias(boolean match)

Matches persons with any surname alias.

Parameters:

match - true to match persons with any surname alias, false to match persons with no surname alias

Compliance:

mandatory - This method must be implemented.

clearSurnameAliasTerms

void clearSurnameAliasTerms()

Clears all surname alias terms.

Compliance:

mandatory - This method must be implemented.

matchGenerationQualifier

void matchGenerationQualifier(String generationQualifier,
 Type stringMatchType,
 boolean match)

Matches a generation qualifier.

Parameters:

generationQualifier - a generation qualifier

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - generationQualifier is not of stringMatchType

NullArgumentException - generationQualifier or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyGenerationQualifier

void matchAnyGenerationQualifier(boolean match)

Matches persons with any generation qualifier.

Parameters:

match - true to match persons with any generation qualifier, false to match persons with no generation qualifier

Compliance:

mandatory - This method must be implemented.

clearGenerationQualifierTerms

void clearGenerationQualifierTerms()

Clears all generation qualifier terms.

Compliance:

mandatory - This method must be implemented.

matchQualificationSuffix

void matchQualificationSuffix(String qualificationSuffix,
 Type stringMatchType,
 boolean match)

Matches a qualification suffix.

Parameters:

qualificationSuffix - a qualification suffix

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - qualificationSuffix is not of stringMatchType

NullArgumentException - qualificationSuffix or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyQualificationSuffix

void matchAnyQualificationSuffix(boolean match)

Matches persons with any qualification suffix.

Parameters:

match - true to match persons with any qualification sufix, false to match persons with no qualification suffix

Compliance:

mandatory - This method must be implemented.

clearQualificationSuffixTerms

void clearQualificationSuffixTerms()

Clears all qualification suffix terms.

Compliance:

mandatory - This method must be implemented.

matchBirthDate

void matchBirthDate(DateTime from,
 DateTime to,
 boolean match)

Matches a birth date bwteen the given range inclusive.

Parameters:

from - a starting date

to - an ending date

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyBirthDate

void matchAnyBirthDate(boolean match)

Matches persons with any birth date.

Parameters:

match - true to match persons with any date of birth, false to match persons with no date of birth

Compliance:

mandatory - This method must be implemented.

clearBirthDateTerms

void clearBirthDateTerms()

Clears all birth date terms.

Compliance:

mandatory - This method must be implemented.

matchDeathDate

void matchDeathDate(DateTime from,
 DateTime to,
 boolean match)

Matches a death date between the given range inclusive.

Parameters:

from - a starting date

to - an ending date

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyDeathDate

void matchAnyDeathDate(boolean match)

Matches persons with any death date.

Parameters:

match - true to match persons with any date of death, false to match persons who might still be alive

Compliance:

mandatory - This method must be implemented.

clearDeathDateTerms

void clearDeathDateTerms()

Clears all death date terms.

Compliance:

mandatory - This method must be implemented.

matchLivingDate

void matchLivingDate(DateTime from,
 DateTime to,
 boolean match)

Matches a persons alive within the given dates inclusive.

Parameters:

from - a starting date

to - an ending date

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

clearLivingDateTerms

void clearLivingDateTerms()

Clears all living date terms.

Compliance:

mandatory - This method must be implemented.

matchInstitutionalIdentifier

void matchInstitutionalIdentifier(String identifier,
 Type stringMatchType,
 boolean match)

Matches an institutional identifier.

Parameters:

identifier - an institutional identifier

stringMatchType - a string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - identifier is not of stringMatchType

NullArgumentException - identifier or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyInstitutionalIdentifier

void matchAnyInstitutionalIdentifier(boolean match)

Matches persons with any institutional identifier.

Parameters:

match - true to match persons with any institutional identifier, false to match persons with no instituional identifier

Compliance:

mandatory - This method must be implemented.

clearInstitutionalIdentifierTerms

void clearInstitutionalIdentifierTerms()

Clears all institutional identifier terms.

Compliance:

mandatory - This method must be implemented.

matchRealmId

void matchRealmId(Id realmId,
 boolean match)

Sets the realm Id for this query to match persons assigned to realms.

Parameters:

realmId - a realm Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - realmId is null

Compliance:

mandatory - This method must be implemented.

clearRealmIdTerms

void clearRealmIdTerms()

Clears all realm Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRealmQuery

boolean supportsRealmQuery()

Tests if a RealmQuery is available.

Returns:

true if a realm query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRealmQuery

RealmQuery getRealmQuery()

Gets the query for a realm query. Multiple retrievals produce a nested OR term.

Returns:

the realm query

Throws:

UnimplementedException - supportsRealmQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRealmQuery()} is {@code true} .

clearRealmTerms

void clearRealmTerms()

Clears all realm terms.

Compliance:

mandatory - This method must be implemented.

getPersonQueryRecord

PersonQueryRecord getPersonQueryRecord(Type personRecordType)
                                throws OperationFailedException

Gets the person query record corresponding to the given Person record Type .Multiple record retrievals produce a nested OR term.

Parameters:

personRecordType - a person record type

Returns:

the person query record

Throws:

NullArgumentException - personRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(personRecordType) is false

Compliance:

mandatory - This method must be implemented.