Interface PersonBatchForm

All Superinterfaces:

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

public interface PersonBatchForm
extends PersonForm

This is the form for creating and updating persons in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PersonBatchAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Modifier and Type	Method	Description
Id	getPersonId()	Gets the Id of the person to be updated if this is an update transaction.

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 Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface PersonForm

clearBirthDate, clearDeathDate, clearForenameAliases, clearGenerationQualifier, clearGivenName, clearInstitutionalIdentifier, clearMiddleNames, clearPreferredName, clearQualificationSuffix, clearSalutation, clearSurname, clearSurnameAliases, getBirthDateMetadata, getDeathDateMetadata, getForenameAliasesMetadata, getGenerationQualifierMetadata, getGivenNameMetadata, getInstitutionalIdentifierMetadata, getMiddleNamesMetadata, getPersonFormRecord, getPreferredNameMetadata, getQualificationSuffixMetadata, getSalutationMetadata, getSurnameAliasesMetadata, getSurnameMetadata, setBirthDate, setDeathDate, setForenameAliases, setGenerationQualifier, setGivenName, setInstitutionalIdentifier, setMiddleNames, setPreferredName, setQualificationSuffix, setSalutation, setSurname, setSurnameAliases

Modifier and Type	Method	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	clearQualificationSuffix()	Clears the qualification suffix.
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	getQualificationSuffixMetadata()	Gets the metadata for a qualification suffix.
Metadata	getSalutationMetadata()	Gets the metadata for a salutation.
Metadata	getSurnameAliasesMetadata()	Gets the metadata for surname aliases.
Metadata	getSurnameMetadata()	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(String[] aliases)	Sets the forename aliases.
void	setGenerationQualifier(String qualifier)	Sets the generation qualifier.
void	setGivenName(String givenName)	Sets the given name,
void	setInstitutionalIdentifier(String identifier)	Sets the identifier.
void	setMiddleNames(String[] names)	Sets the middle names.
void	setPreferredName(String preferredName)	Sets the preferred name,
void	setQualificationSuffix(String qualificationSuffix)	Sets the qualification suffix.
void	setSalutation(String salutation)	Sets the salutation.
void	setSurname(String surname)	Sets the surname.
void	setSurnameAliases(String[] aliases)	Sets the surname aliases.

Method Details

getPersonId

Id getPersonId()

Gets the Id of the person to be updated if this is an update transaction.

Returns:

the person Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.