OSID Logo
OSID Specifications
contact package
Version 3.1.0
Interfaceosid.contact.AddressBookForm
Implementsosid.OsidCatalogForm
Implemented Byosid.contact.batch.AddressBookBatchForm
Used Byosid.contact.AddressBookAdminSession
Description

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.

Like all OsidForms, AddressBookForm is stateful and must not be accessed by multiple processing threads.

MethodgetAddressBookFormRecord
Description

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

Parametersosid.type.TypeaddressBookRecordType the address book record type
Returnosid.contact.records.AddressBookFormRecord the address book form record
ErrorsNULL_ARGUMENT addressBookRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(addressBookRecordType) is false
Compliancemandatory This method must be implemented.