org.osid.contact

Interface AddressForm

All Superinterfaces:

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

All Known Subinterfaces:

AddressBatchForm

public interface AddressForm
extends OsidObjectForm

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 Summary

Methods

Modifier and Type	Method and Description
void	clearResource() Clears the resource.
AddressFormRecord	getAddressFormRecord(Type addressRecordType) Gets the AddressFormRecord corresponding to the given address record Type.
Metadata	getResourceMetadata() Gets the metadata for the resource.
void	setResource(Id resourceId) Sets the resource.

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getResourceMetadata

Metadata getResourceMetadata()

Gets the metadata for the resource.

Returns:

metadata for the addressee

Compliance:

mandatory - This method must be implemented.

setResource

void setResource(Id resourceId)

Sets the resource.

Parameters:

resourceId - a resource Id

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResource

void clearResource()

Clears the resource.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getAddressFormRecord

AddressFormRecord getAddressFormRecord(Type addressRecordType)
                                       throws OperationFailedException

Gets the AddressFormRecord corresponding to the given address record Type.

Parameters:

addressRecordType - the address record type

Returns:

the address form record

Throws:

NullArgumentException - addressRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressRecordType) is false

Compliance:

mandatory - This method must be implemented.