OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressBookForm
Implementsosid.OsidCatalogForm
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.

MethodgetAddressBookFormRecord
Description

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

Parametersosid.type.TypeaddressBookRecordTypethe address book record type
Returnosid.contact.records.AddressBookFormRecordthe address book form record
ErrorsNULL_ARGUMENT addressBookRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(addressBookRecordType) is false
CompliancemandatoryThis method must be implemented.