OSID - osid.contact.AddressForm Service Interface Definition

Interface	osid.contact.AddressForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.contact.batch.AddressBatchForm`
Used By	`osid.contact.AddressAdminSession`
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.
Method	getResourceMetadata
Description	Gets the metadata for the resource.
Return	`osid.Metadata`		metadata for the addressee
Compliance	`mandatory`		This method must be implemented.
Method	setResource
Description	Sets the resource.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Errors	INVALID_ARGUMENT		`resourceId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResource
Description	Clears the resource.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAddressTextMetadata
Description	Gets the metadata for the address text.
Return	`osid.Metadata`		metadata for the address text
Compliance	`mandatory`		This method must be implemented.
Method	setAddressText
Description	Sets the address text.
Parameters	`string`	`addressText`	the address text
Errors	INVALID_ARGUMENT		`addressText` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`addressText` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAddressText
Description	Clears the address text.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAddressFormRecord
Description	Gets the `AddressFormRecord` corresponding to the given address record `Type` .
Parameters	`osid.type.Type`	`addressRecordType`	the address record type
Return	`osid.contact.records.AddressFormRecord`		the address form record
Errors	NULL_ARGUMENT		`addressRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(addressRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.