OSID - osid.personnel.PersonQuery Service Interface Definition

Interface	osid.personnel.PersonQuery
Implements	`osid.OsidObjectQuery`
Description	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	matchSalutation
Description	Matches a salutation.
Parameters	`string`	`salutation`	a salutation
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`salutation` is not of `stringMatchType`
	NULL_ARGUMENT		`salutation` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySalutation
Description	Matches persons with any salutation.
Parameters	`boolean`	`match`	`true` to match persons with any salutation, `false` to match persons with no salutation
Compliance	`mandatory`		This method must be implemented.
Method	clearSalutationTerms
Description	Clears all salutation terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGivenName
Description	Matches a given name.
Parameters	`string`	`givenName`	a given name
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`givenName` is not of `stringMatchType`
	NULL_ARGUMENT		`givenName` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyGivenName
Description	Matches persons with any given name.
Parameters	`boolean`	`match`	`true` to match persons with any given name, `false` to match persons with no given name
Compliance	`mandatory`		This method must be implemented.
Method	clearGivenNameTerms
Description	Clears all given name terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPreferredName
Description	Matches a preferred name.
Parameters	`string`	`preferredName`	a preferred name
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`preferredName` is not of `stringMatchType`
	NULL_ARGUMENT		`preferredName` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPreferredName
Description	Matches persons with any preferred name.
Parameters	`boolean`	`match`	`true` to match persons with any preferred name, `false` to match persons with no preferred name
Compliance	`mandatory`		This method must be implemented.
Method	clearPreferredNameTerms
Description	Clears all preferred name terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchForenameAlias
Description	Matches a forename alias.
Parameters	`string`	`forenameAlias`	a forename alias
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`forenameAlias` is not of `stringMatchType`
	NULL_ARGUMENT		`forenameAlias` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyForenameAlias
Description	Matches persons with any forename alias.
Parameters	`boolean`	`match`	`true` to match persons with any forename alias, `false` to match persons with no forename aliases
Compliance	`mandatory`		This method must be implemented.
Method	clearForenameAliasTerms
Description	Clears all forename alias terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMiddleName
Description	Matches a middle name.
Parameters	`string`	`middleName`	a middle name
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`middleName` is not of `stringMatchType`
	NULL_ARGUMENT		`middleName` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMiddleName
Description	Matches persons with any middle name.
Parameters	`boolean`	`match`	`true` to match persons with any middle name, `false` to match persons with no middle name
Compliance	`mandatory`		This method must be implemented.
Method	clearMiddleNameTerms
Description	Clears all middle name terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSurname
Description	Matches a surname.
Parameters	`string`	`surName`	a surname
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`surName` is not of `stringMatchType`
	NULL_ARGUMENT		`surName` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySurname
Description	Matches persons with any surname.
Parameters	`boolean`	`match`	`true` to match persons with any surname, `false` to match persons with no surname
Compliance	`mandatory`		This method must be implemented.
Method	clearSurnameTerms
Description	Clears all surname terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSurnameAlias
Description	Matches a surname alias.
Parameters	`string`	`surnameAlias`	a surname alias
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`surnameAlias` is not of `stringMatchType`
	NULL_ARGUMENT		`surnameAlias` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySurnameAlias
Description	Matches persons with any surname alias.
Parameters	`boolean`	`match`	`true` to match persons with any surname alias, `false` to match persons with no surname alias
Compliance	`mandatory`		This method must be implemented.
Method	clearSurnameAliasTerms
Description	Clears all surname alias terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGenerationQualifier
Description	Matches a generation qualifier.
Parameters	`string`	`generationQualifier`	a generation qualifier
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`generationQualifier` is not of `stringMatchType`
	NULL_ARGUMENT		`generationQualifier` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyGenerationQualifier
Description	Matches persons with any generation qualifier.
Parameters	`boolean`	`match`	`true` to match persons with any generation qualifier, `false` to match persons with no generation qualifier
Compliance	`mandatory`		This method must be implemented.
Method	clearGenerationQualifierTerms
Description	Clears all generation qualifier terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchQualificationSuffix
Description	Matches a qualification suffix.
Parameters	`string`	`qualificationSuffix`	a qualification suffix
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`qualificationSuffix` is not of `stringMatchType`
	NULL_ARGUMENT		`qualificationSuffix` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyQualificationSuffix
Description	Matches persons with any qualification suffix.
Parameters	`boolean`	`match`	`true` to match persons with any qualification sufix, `false` to match persons with no qualification suffix
Compliance	`mandatory`		This method must be implemented.
Method	clearQualificationSuffixTerms
Description	Clears all qualification suffix terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBirthDate
Description	Matches a birth date bwteen the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	a starting date
	`osid.calendaring.DateTime`	`to`	an ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyBirthDate
Description	Matches persons with any birth date.
Parameters	`boolean`	`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.
Method	clearBirthDateTerms
Description	Clears all birth date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDeathDate
Description	Matches a death date between the given range inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	a starting date
	`osid.calendaring.DateTime`	`to`	an ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDeathDate
Description	Matches persons with any death date.
Parameters	`boolean`	`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.
Method	clearDeathDateTerms
Description	Clears all death date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLivingDate
Description	Matches a persons alive within the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	a starting date
	`osid.calendaring.DateTime`	`to`	an ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLivingDateTerms
Description	Clears all living date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInstitutionalIdentifier
Description	Matches an institutional identifier.
Parameters	`string`	`identifier`	an institutional identifier
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`identifier` is not of `stringMatchType`
	NULL_ARGUMENT		`identifier` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyInstitutionalIdentifier
Description	Matches persons with any institutional identifier.
Parameters	`boolean`	`match`	`true` to match persons with any institutional identifier, `false` to match persons with no instituional identifier
Compliance	`mandatory`		This method must be implemented.
Method	clearInstitutionalIdentifierTerms
Description	Clears all institutional identifier terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRealmId
Description	Sets the realm `Id` for this query to match persons assigned to realms.
Parameters	`osid.id.Id`	`realmId`	a realm `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`realmId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRealmIdTerms
Description	Clears all realm `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRealmQuery
Description	Tests if a `RealmQuery` is available.
Return	`boolean`		`true` if a realm query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRealmQuery
Description	Gets the query for a realm query. Multiple retrievals produce a nested `OR` term.
Return	`osid.personnel.RealmQuery`		the realm query
Errors	UNIMPLEMENTED		`supportsRealmQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRealmQuery()` is `true.`
Method	clearRealmTerms
Description	Clears all realm terms.
Compliance	`mandatory`		This method must be implemented.
Method	getPersonQueryRecord
Description	Gets the person query record corresponding to the given `Person` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`personRecordType`	a person record type
Return	`osid.personnel.records.PersonQueryRecord`		the person 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.