Interface BuildingForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidTemporalForm, Suppliable
All Known Subinterfaces:
BuildingBatchForm
public interface BuildingForm extends OsidObjectForm, OsidTemporalForm

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

  • Method Details

    • getAddressMetadata

      Metadata getAddressMetadata()
      Gets the metadata for an address.
      Returns:
      metadata for the address
      Compliance:
      mandatory - This method must be implemented.

    • setAddress

      void setAddress(Id addressId)
      Sets the address.
      Parameters:
      addressId - the new address
      Throws:
      InvalidArgumentException - addressId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - addressId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAddress

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

    • getOfficialNameMetadata

      Metadata getOfficialNameMetadata()
      Gets the metadata for an official name.
      Returns:
      metadata for the official name
      Compliance:
      mandatory - This method must be implemented.

    • setOfficialName

      void setOfficialName(String name)
      Sets the official name.
      Parameters:
      name - the new name
      Throws:
      InvalidArgumentException - name is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - name is null
      Compliance:
      mandatory - This method must be implemented.

    • clearOfficialName

      void clearOfficialName()
      Clears the official name.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getNumberMetadata

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

    • setNumber

      void setNumber(String number)
      Sets the building number.
      Parameters:
      number - the new number
      Throws:
      InvalidArgumentException - number is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - number is null
      Compliance:
      mandatory - This method must be implemented.

    • clearNumber

      void clearNumber()
      Clears the building number.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getEnclosingBuildingMetadata

      Metadata getEnclosingBuildingMetadata()
      Gets the metadata for an enclosing building.
      Returns:
      metadata for the enclosing building
      Compliance:
      mandatory - This method must be implemented.

    • setEnclosingBuilding

      void setEnclosingBuilding(Id buildingId)
      Sets the enclosing building.
      Parameters:
      buildingId - the new enclosing building
      Throws:
      InvalidArgumentException - buildingId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - buildingId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEnclosingBuilding

      void clearEnclosingBuilding()
      Clears the enclosing building.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGrossAreaMetadata

      Metadata getGrossAreaMetadata()
      Gets the metadata for the gross area.
      Returns:
      metadata for the area
      Compliance:
      mandatory - This method must be implemented.

    • setGrossArea

      void setGrossArea(BigDecimal area)
      Sets the gross area.
      Parameters:
      area - the new area
      Throws:
      InvalidArgumentException - area is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearGrossArea

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

    • getBuildingFormRecord

      BuildingFormRecord getBuildingFormRecord(Type buildingRecordType) throws OperationFailedException
      Gets the BuildingFormRecord corresponding to the given building record Type.
      Parameters:
      buildingRecordType - the building record type
      Returns:
      the building form record
      Throws:
      NullArgumentException - buildingRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(buildingRecordType) is false
      Compliance:
      mandatory - This method must be implemented.