OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.AddressBook
Implementsosid.OsidCatalog
Description

An AddressBook represents a collection of contacts. Like all OSID objects, a AddressBook is identified by its Id and any persisted references should use the Id.

MethodgetAddressBookRecord
Description

Gets the address book record corresponding to the given AddressBook record Type. This method is used to retrieve an object implementing the requested record. The addressBookRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(addressBookRecordType) is true .

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