org.osid.personnel

Interface PersonForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

PersonBatchForm

public interface PersonForm
extends OsidObjectForm

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 Summary

Methods

Modifier and Type	Method and Description
void	clearBirthDate() Clears the date of birth.
void	clearDeathDate() Clears the date of death.
void	clearForenameAliases() Clears the forename aliases.
void	clearGenerationQualifier() Clears the generation qualifier.
void	clearGivenName() Clears the given name.
void	clearInstitutionalIdentifier() Clears the identifier.
void	clearMiddleNames() Clears the middele names.
void	clearPreferredName() Clears the preferred name.
void	clearSalutation() Clears the salutation.
void	clearSurname() Clears the surname.
void	clearSurnameAliases() Clears the surname aliases.
Metadata	getBirthDateMetadata() Gets the metadata for a date of birth.
Metadata	getDeathDateMetadata() Gets the metadata for a date of death.
Metadata	getForenameAliasesMetadata() Gets the metadata for forename aliases.
Metadata	getGenerationQualifierMetadata() Gets the metadata for a generation qualifier.
Metadata	getGivenNameMetadata() Gets the metadata for a given name.
Metadata	getInstitutionalIdentifierMetadata() Gets the metadata for an identifier.
Metadata	getMiddleNamesMetadata() Gets the metadata for middle names.
PersonFormRecord	getPersonFormRecord(Type personRecordType) Gets the PersonFormRecord interface corresponding to the given person record Type.
Metadata	getPreferredNameMetadata() Gets the metadata for a preferred name.
Metadata	getSalutationMetadata() Gets the metadata for a salutation.
Metadata	getSurameAliasesMetadata() Gets the metadata for surname aliases.
Metadata	getSurameMetadata() Gets the metadata for a surname.
void	setBirthDate(DateTime date) Sets the date of birth.
void	setDeathDate(DateTime date) Sets the date of death.
void	setForenameAliases(java.lang.String[] aliases) Sets the forename aliases.
void	setGenerationQualifier(java.lang.String qualifier) Sets the generation qualifier.
void	setGivenName(java.lang.String givenName) Sets the given name,
void	setInstitutionalIdentifier(java.lang.String identifier) Sets the identifier.
void	setMiddleNames(java.lang.String[] names) Sets the middle names.
void	setPreferredName(java.lang.String preferredName) Sets the preferred name,
void	setSalutation(java.lang.String salutation) Sets the salutation.
void	setSurname(java.lang.String surname) Sets the surname.
void	setSurnameAliases(java.lang.String[] aliases) Sets the surname aliases.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getSalutationMetadata

Metadata getSalutationMetadata()

Gets the metadata for a salutation.

Returns:

metadata for the salutation

Compliance:

mandatory - This method must be implemented.

setSalutation

void setSalutation(java.lang.String salutation)

Sets the salutation.

Parameters:

salutation - the salutation

Throws:

InvalidArgumentException - salutation is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - salutation is null

Compliance:

mandatory - This method must be implemented.

clearSalutation

void clearSalutation()

Clears the salutation.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getGivenNameMetadata

Metadata getGivenNameMetadata()

Gets the metadata for a given name.

Returns:

metadata for the given name

Compliance:

mandatory - This method must be implemented.

setGivenName

void setGivenName(java.lang.String givenName)

Sets the given name,

Parameters:

givenName - the given name

Throws:

InvalidArgumentException - givenName is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - givenName is null

Compliance:

mandatory - This method must be implemented.

clearGivenName

void clearGivenName()

Clears the given name.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPreferredNameMetadata

Metadata getPreferredNameMetadata()

Gets the metadata for a preferred name.

Returns:

metadata for the preferred name

Compliance:

mandatory - This method must be implemented.

setPreferredName

void setPreferredName(java.lang.String preferredName)

Sets the preferred name,

Parameters:

preferredName - the preferred name

Throws:

InvalidArgumentException - preferredName is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - preferredName is null

Compliance:

mandatory - This method must be implemented.

clearPreferredName

void clearPreferredName()

Clears the preferred name.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getForenameAliasesMetadata

Metadata getForenameAliasesMetadata()

Gets the metadata for forename aliases.

Returns:

metadata for the forename aliases

Compliance:

mandatory - This method must be implemented.

setForenameAliases

void setForenameAliases(java.lang.String[] aliases)

Sets the forename aliases.

Parameters:

aliases - the forename aliases

Throws:

InvalidArgumentException - forenames is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - forenames is null

Compliance:

mandatory - This method must be implemented.

clearForenameAliases

void clearForenameAliases()

Clears the forename aliases.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getMiddleNamesMetadata

Metadata getMiddleNamesMetadata()

Gets the metadata for middle names.

Returns:

metadata for the middle names

Compliance:

mandatory - This method must be implemented.

setMiddleNames

void setMiddleNames(java.lang.String[] names)

Sets the middle names.

Parameters:

names - the middle names

Throws:

InvalidArgumentException - names is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - names is null

Compliance:

mandatory - This method must be implemented.

clearMiddleNames

void clearMiddleNames()

Clears the middele names.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSurameMetadata

Metadata getSurameMetadata()

Gets the metadata for a surname.

Returns:

metadata for the surname

Compliance:

mandatory - This method must be implemented.

setSurname

void setSurname(java.lang.String surname)

Sets the surname.

Parameters:

surname - the surname

Throws:

InvalidArgumentException - surname is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - surname is null

Compliance:

mandatory - This method must be implemented.

clearSurname

void clearSurname()

Clears the surname.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSurameAliasesMetadata

Metadata getSurameAliasesMetadata()

Gets the metadata for surname aliases.

Returns:

metadata for the surname aliases

Compliance:

mandatory - This method must be implemented.

setSurnameAliases

void setSurnameAliases(java.lang.String[] aliases)

Sets the surname aliases.

Parameters:

aliases - the aliases

Throws:

InvalidArgumentException - aliases is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - aliases is null

Compliance:

mandatory - This method must be implemented.

clearSurnameAliases

void clearSurnameAliases()

Clears the surname aliases.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getGenerationQualifierMetadata

Metadata getGenerationQualifierMetadata()

Gets the metadata for a generation qualifier.

Returns:

metadata for the qualifier

Compliance:

mandatory - This method must be implemented.

setGenerationQualifier

void setGenerationQualifier(java.lang.String qualifier)

Sets the generation qualifier.

Parameters:

qualifier - the qualifier

Throws:

InvalidArgumentException - qualifier is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - qualifier is null

Compliance:

mandatory - This method must be implemented.

clearGenerationQualifier

void clearGenerationQualifier()

Clears the generation qualifier.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getBirthDateMetadata

Metadata getBirthDateMetadata()

Gets the metadata for a date of birth.

Returns:

metadata for the date of birth

Compliance:

mandatory - This method must be implemented.

setBirthDate

void setBirthDate(DateTime date)

Sets the date of birth.

Parameters:

date - the date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearBirthDate

void clearBirthDate()

Clears the date of birth.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDeathDateMetadata

Metadata getDeathDateMetadata()

Gets the metadata for a date of death.

Returns:

metadata for the date of death

Compliance:

mandatory - This method must be implemented.

setDeathDate

void setDeathDate(DateTime date)

Sets the date of death.

Parameters:

date - the date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDeathDate

void clearDeathDate()

Clears the date of death.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getInstitutionalIdentifierMetadata

Metadata getInstitutionalIdentifierMetadata()

Gets the metadata for an identifier.

Returns:

metadata for the identifier

Compliance:

mandatory - This method must be implemented.

setInstitutionalIdentifier

void setInstitutionalIdentifier(java.lang.String identifier)

Sets the identifier.

Parameters:

identifier - the identifier

Throws:

InvalidArgumentException - identifier is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - identifier is null

Compliance:

mandatory - This method must be implemented.

clearInstitutionalIdentifier

void clearInstitutionalIdentifier()

Clears the identifier.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPersonFormRecord

PersonFormRecord getPersonFormRecord(Type personRecordType)
                                     throws OperationFailedException

Gets the PersonFormRecord interface corresponding to the given person record Type.

Parameters:

personRecordType - the person record type

Returns:

the record

Throws:

NullArgumentException - personRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(personRecordType) is false

Compliance:

mandatory - This method must be implemented.