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 Details

    • getSalutationMetadata

      Metadata getSalutationMetadata()
      Gets the metadata for a salutation.
      Returns:
      metadata for the salutation
      Compliance:
      mandatory - This method must be implemented.

    • setSalutation

      void setSalutation(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(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(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(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(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.

    • getQualificationSuffixMetadata

      Metadata getQualificationSuffixMetadata()
      Gets the metadata for a qualification suffix.
      Returns:
      metadata for the qualification suffix
      Compliance:
      mandatory - This method must be implemented.

    • setQualificationSuffix

      void setQualificationSuffix(String qualificationSuffix)
      Sets the qualification suffix.
      Parameters:
      qualificationSuffix - the qualification suffix
      Throws:
      InvalidArgumentException - qualificationSuffix is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - qualificationSuffix is null
      Compliance:
      mandatory - This method must be implemented.

    • clearQualificationSuffix

      void clearQualificationSuffix()
      Clears the qualification suffix.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getSurnameMetadata

      Metadata getSurnameMetadata()
      Gets the metadata for a surname.
      Returns:
      metadata for the surname
      Compliance:
      mandatory - This method must be implemented.

    • setSurname

      void setSurname(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.

    • getSurnameAliasesMetadata

      Metadata getSurnameAliasesMetadata()
      Gets the metadata for surname aliases.
      Returns:
      metadata for the surname aliases
      Compliance:
      mandatory - This method must be implemented.

    • setSurnameAliases

      void setSurnameAliases(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(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(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.