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.
Modifier and Type | Method and 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. |
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(java.lang.String forenameAlias,
Type stringMatchType,
boolean match)
Matches a forename alias.
|
void |
matchGenerationQualifier(java.lang.String generationQualifier,
Type stringMatchType,
boolean match)
Matches a generation qualifier.
|
void |
matchGivenName(java.lang.String givenName,
Type stringMatchType,
boolean match)
Matches a given name.
|
void |
matchInstitutionalIdentifier(java.lang.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(java.lang.String middleName,
Type stringMatchType,
boolean match)
Matches a middle name.
|
void |
matchPreferredName(java.lang.String preferredName,
Type stringMatchType,
boolean match)
Matches a preferred name.
|
void |
matchQualificationSuffix(java.lang.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(java.lang.String salutation,
Type stringMatchType,
boolean match)
Matches a salutation.
|
void |
matchSurname(java.lang.String surName,
Type stringMatchType,
boolean match)
Matches a surname.
|
void |
matchSurnameAlias(java.lang.String surnameAlias,
Type stringMatchType,
boolean match)
Matches a surname alias.
|
boolean |
supportsRealmQuery()
Tests if a
RealmQuery is available. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchSalutation(java.lang.String salutation, Type stringMatchType, boolean match)
salutation
- a salutationstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- salutation
is
not of stringMatchType
NullArgumentException
- salutation
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnySalutation(boolean match)
match
- true
to match persons with any
salutation, false
to match persons with no
salutationmandatory
- This method must be implemented. void clearSalutationTerms()
mandatory
- This method must be implemented. void matchGivenName(java.lang.String givenName, Type stringMatchType, boolean match)
givenName
- a given namestringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- givenName
is
not of stringMatchType
NullArgumentException
- givenName
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyGivenName(boolean match)
match
- true
to match persons with any given
name, false
to match persons with no given namemandatory
- This method must be implemented. void clearGivenNameTerms()
mandatory
- This method must be implemented. void matchPreferredName(java.lang.String preferredName, Type stringMatchType, boolean match)
preferredName
- a preferred namestringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- preferredName
is not of stringMatchType
NullArgumentException
- preferredName
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyPreferredName(boolean match)
match
- true
to match persons with any preferred
name, false
to match persons with no preferred
namemandatory
- This method must be implemented. void clearPreferredNameTerms()
mandatory
- This method must be implemented. void matchForenameAlias(java.lang.String forenameAlias, Type stringMatchType, boolean match)
forenameAlias
- a forename aliasstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- forenameAlias
is not of stringMatchType
NullArgumentException
- forenameAlias
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyForenameAlias(boolean match)
match
- true
to match persons with any forename
alias, false
to match persons with no forename
aliasesmandatory
- This method must be implemented. void clearForenameAliasTerms()
mandatory
- This method must be implemented. void matchMiddleName(java.lang.String middleName, Type stringMatchType, boolean match)
middleName
- a middle namestringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- middleName
is
not of stringMatchType
NullArgumentException
- middleName
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyMiddleName(boolean match)
match
- true
to match persons with any middle
name, false
to match persons with no middle
namemandatory
- This method must be implemented. void clearMiddleNameTerms()
mandatory
- This method must be implemented. void matchSurname(java.lang.String surName, Type stringMatchType, boolean match)
surName
- a surnamestringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- surName
is
not of stringMatchType
NullArgumentException
- surName
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnySurname(boolean match)
match
- true
to match persons with any surname,
false
to match persons with no surnamemandatory
- This method must be implemented. void clearSurnameTerms()
mandatory
- This method must be implemented. void matchSurnameAlias(java.lang.String surnameAlias, Type stringMatchType, boolean match)
surnameAlias
- a surname aliasstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- surnameAlias
is not of stringMatchType
NullArgumentException
- surnameAlias
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnySurnameAlias(boolean match)
match
- true
to match persons with any surname
alias, false
to match persons with no surname
aliasmandatory
- This method must be implemented. void clearSurnameAliasTerms()
mandatory
- This method must be implemented. void matchGenerationQualifier(java.lang.String generationQualifier, Type stringMatchType, boolean match)
generationQualifier
- a generation qualifierstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- generationQualifier
is not of stringMatchType
NullArgumentException
- generationQualifier
or stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyGenerationQualifier(boolean match)
match
- true
to match persons with any generation
qualifier, false
to match persons with no
generation qualifiermandatory
- This method must be implemented. void clearGenerationQualifierTerms()
mandatory
- This method must be implemented. void matchQualificationSuffix(java.lang.String qualificationSuffix, Type stringMatchType, boolean match)
qualificationSuffix
- a qualification suffixstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- qualificationSuffix
is not of stringMatchType
NullArgumentException
- qualificationSuffix
or stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyQualificationSuffix(boolean match)
match
- true
to match persons with any
qualification sufix, false
to match persons
with no qualification suffixmandatory
- This method must be implemented. void clearQualificationSuffixTerms()
mandatory
- This method must be implemented. void matchBirthDate(DateTime from, DateTime to, boolean match)
from
- a starting dateto
- an ending datematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyBirthDate(boolean match)
match
- true
to match persons with any date of
birth, false
to match persons with no date of
birthmandatory
- This method must be implemented. void clearBirthDateTerms()
mandatory
- This method must be implemented. void matchDeathDate(DateTime from, DateTime to, boolean match)
from
- a starting dateto
- an ending datematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyDeathDate(boolean match)
match
- true
to match persons with any date of
death, false
to match persons who might still
be alivemandatory
- This method must be implemented. void clearDeathDateTerms()
mandatory
- This method must be implemented. void matchLivingDate(DateTime from, DateTime to, boolean match)
from
- a starting dateto
- an ending datematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearLivingDateTerms()
mandatory
- This method must be implemented. void matchInstitutionalIdentifier(java.lang.String identifier, Type stringMatchType, boolean match)
identifier
- an institutional identifierstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- identifier
is
not of stringMatchType
NullArgumentException
- identifier
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyInstitutionalIdentifier(boolean match)
match
- true
to match persons with any
institutional identifier, false
to match
persons with no instituional identifiermandatory
- This method must be implemented. void clearInstitutionalIdentifierTerms()
mandatory
- This method must be implemented. void matchRealmId(Id realmId, boolean match)
Id
for this query to match persons
assigned to realms.realmId
- a realm Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- realmId
is
null
mandatory
- This method must be implemented. void clearRealmIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRealmQuery()
RealmQuery
is available. true
if a realm query is available,
false
otherwisemandatory
- This method must be implemented. RealmQuery getRealmQuery()
OR
term.UnimplementedException
- supportsRealmQuery()
is false
optional
- This method must be implemented if
supportsRealmQuery()
is true.
void clearRealmTerms()
mandatory
- This method must be implemented. PersonQueryRecord getPersonQueryRecord(Type personRecordType) throws OperationFailedException
Person
record Type.
Multiple record retrievals produce
a nested OR
term.personRecordType
- a person record typeNullArgumentException
- personRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(personRecordType)
is false
mandatory
- This method must be implemented.