org.osid.contact

Interface ContactForm

All Superinterfaces:

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

All Known Subinterfaces:

ContactBatchForm

public interface ContactForm
extends OsidRelationshipForm

This is the form for creating and updating Contact objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ContactAdminSession. 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	clearAddressee() Clears the addressee.
Metadata	getAddresseeMetadata() Gets the metadata for the addressee.
ContactFormRecord	getContactFormRecord(Type contactRecordType) Gets the ContactFormRecord corresponding to the given contact record Type.
void	setAddressee(Id resourceId) Sets the addressee.

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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getAddresseeMetadata

Metadata getAddresseeMetadata()

Gets the metadata for the addressee.

Returns:

metadata for the addressee

Compliance:

mandatory - This method must be implemented.

setAddressee

void setAddressee(Id resourceId)

Sets the addressee.

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.

clearAddressee

void clearAddressee()

Clears the addressee.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getContactFormRecord

ContactFormRecord getContactFormRecord(Type contactRecordType)
                                       throws OperationFailedException

Gets the ContactFormRecord corresponding to the given contact record Type.

Parameters:

contactRecordType - the contact record type

Returns:

the contact form record

Throws:

NullArgumentException - contactRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(contactRecordType) is false

Compliance:

mandatory - This method must be implemented.