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

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

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

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.

getAddressTextMetadata

Metadata getAddressTextMetadata()

Gets the metadata for the address text.

Returns:

metadata for the address text

Compliance:

mandatory - This method must be implemented.

setAddressText

void setAddressText(String addressText)

Sets the address text.

Parameters:

addressText - the address text

Throws:

InvalidArgumentException - addressText is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - addressText is null

Compliance:

mandatory - This method must be implemented.

clearAddressText

void clearAddressText()

Clears the address text.

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.