OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressForm
Implementsosid.OsidObjectForm
Description

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

MethodgetResourceMetadata
Description

Gets the metadata for the resource.

Returnosid.Metadatametadata for the addressee
CompliancemandatoryThis method must be implemented.
MethodsetResource
Description

Sets the resource.

Parametersosid.id.IdresourceIda resource Id
ErrorsINVALID_ARGUMENT resourceId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearResource
Description

Clears the resource.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetAddressFormRecord
Description

Gets the AddressFormRecord corresponding to the given address record Type.

Parametersosid.type.TypeaddressRecordTypethe address record type
Returnosid.contact.records.AddressFormRecordthe address form record
ErrorsNULL_ARGUMENT addressRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(addressRecordType) is false
CompliancemandatoryThis method must be implemented.