OSID - osid.personnel.PersonForm Service Interface Definition

Interface	osid.personnel.PersonForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.personnel.batch.PersonBatchForm`
Used By	`osid.personnel.PersonAdminSession`
Description	This is the form for creating and updating `Person` objects. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `PersonAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getSalutationMetadata
Description	Gets the metadata for a salutation.
Return	`osid.Metadata`		metadata for the salutation
Compliance	`mandatory`		This method must be implemented.
Method	setSalutation
Description	Sets the salutation.
Parameters	`string`	`salutation`	the salutation
Errors	INVALID_ARGUMENT		`salutation` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`salutation` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearSalutation
Description	Clears the salutation.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGivenNameMetadata
Description	Gets the metadata for a given name.
Return	`osid.Metadata`		metadata for the given name
Compliance	`mandatory`		This method must be implemented.
Method	setGivenName
Description	Sets the given name,
Parameters	`string`	`givenName`	the given name
Errors	INVALID_ARGUMENT		`givenName` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`givenName` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearGivenName
Description	Clears the given name.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPreferredNameMetadata
Description	Gets the metadata for a preferred name.
Return	`osid.Metadata`		metadata for the preferred name
Compliance	`mandatory`		This method must be implemented.
Method	setPreferredName
Description	Sets the preferred name,
Parameters	`string`	`preferredName`	the preferred name
Errors	INVALID_ARGUMENT		`preferredName` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`preferredName` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearPreferredName
Description	Clears the preferred name.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getForenameAliasesMetadata
Description	Gets the metadata for forename aliases.
Return	`osid.Metadata`		metadata for the forename aliases
Compliance	`mandatory`		This method must be implemented.
Method	setForenameAliases
Description	Sets the forename aliases.
Parameters	`string[]`	`aliases`	the forename aliases
Errors	INVALID_ARGUMENT		`forenames` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`forenames` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearForenameAliases
Description	Clears the forename aliases.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMiddleNamesMetadata
Description	Gets the metadata for middle names.
Return	`osid.Metadata`		metadata for the middle names
Compliance	`mandatory`		This method must be implemented.
Method	setMiddleNames
Description	Sets the middle names.
Parameters	`string[]`	`names`	the middle names
Errors	INVALID_ARGUMENT		`names` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`names` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearMiddleNames
Description	Clears the middele names.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getQualificationSuffixMetadata
Description	Gets the metadata for a qualification suffix.
Return	`osid.Metadata`		metadata for the qualification suffix
Compliance	`mandatory`		This method must be implemented.
Method	setQualificationSuffix
Description	Sets the qualification suffix.
Parameters	`string`	`qualificationSuffix`	the qualification suffix
Errors	INVALID_ARGUMENT		`qualificationSuffix` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`qualificationSuffix` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearQualificationSuffix
Description	Clears the qualification suffix.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSurnameMetadata
Description	Gets the metadata for a surname.
Return	`osid.Metadata`		metadata for the surname
Compliance	`mandatory`		This method must be implemented.
Method	setSurname
Description	Sets the surname.
Parameters	`string`	`surname`	the surname
Errors	INVALID_ARGUMENT		`surname` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`surname` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearSurname
Description	Clears the surname.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSurnameAliasesMetadata
Description	Gets the metadata for surname aliases.
Return	`osid.Metadata`		metadata for the surname aliases
Compliance	`mandatory`		This method must be implemented.
Method	setSurnameAliases
Description	Sets the surname aliases.
Parameters	`string[]`	`aliases`	the aliases
Errors	INVALID_ARGUMENT		`aliases` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`aliases` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearSurnameAliases
Description	Clears the surname aliases.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGenerationQualifierMetadata
Description	Gets the metadata for a generation qualifier.
Return	`osid.Metadata`		metadata for the qualifier
Compliance	`mandatory`		This method must be implemented.
Method	setGenerationQualifier
Description	Sets the generation qualifier.
Parameters	`string`	`qualifier`	the qualifier
Errors	INVALID_ARGUMENT		`qualifier` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`qualifier` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearGenerationQualifier
Description	Clears the generation qualifier.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getBirthDateMetadata
Description	Gets the metadata for a date of birth.
Return	`osid.Metadata`		metadata for the date of birth
Compliance	`mandatory`		This method must be implemented.
Method	setBirthDate
Description	Sets the date of birth.
Parameters	`osid.calendaring.DateTime`	`date`	the date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearBirthDate
Description	Clears the date of birth.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDeathDateMetadata
Description	Gets the metadata for a date of death.
Return	`osid.Metadata`		metadata for the date of death
Compliance	`mandatory`		This method must be implemented.
Method	setDeathDate
Description	Sets the date of death.
Parameters	`osid.calendaring.DateTime`	`date`	the date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearDeathDate
Description	Clears the date of death.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getInstitutionalIdentifierMetadata
Description	Gets the metadata for an identifier.
Return	`osid.Metadata`		metadata for the identifier
Compliance	`mandatory`		This method must be implemented.
Method	setInstitutionalIdentifier
Description	Sets the identifier.
Parameters	`string`	`identifier`	the identifier
Errors	INVALID_ARGUMENT		`identifier` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`identifier` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearInstitutionalIdentifier
Description	Clears the identifier.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPersonFormRecord
Description	Gets the `PersonFormRecord` interface corresponding to the given person record `Type` .
Parameters	`osid.type.Type`	`personRecordType`	the person record type
Return	`osid.personnel.records.PersonFormRecord`		the 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.