org.osid.contact

Interface AddressBookForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

AddressBookBatchForm

public interface AddressBookForm
extends OsidCatalogForm

This is the form for creating and updating AddressBooks. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AddressBookAdminSession. 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
AddressBookFormRecord	getAddressBookFormRecord(Type addressBookRecordType) Gets the AddressBookFormRecord corresponding to the given address book record Type.

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.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getAddressBookFormRecord

AddressBookFormRecord getAddressBookFormRecord(Type addressBookRecordType)
                                               throws OperationFailedException

Gets the AddressBookFormRecord corresponding to the given address book record Type.

Parameters:

addressBookRecordType - the address book record type

Returns:

the address book form record

Throws:

NullArgumentException - addressBookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressBookRecordType) is false

Compliance:

mandatory - This method must be implemented.