org.osid.contact

Interface AddressBook

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface AddressBook
extends OsidCatalog

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.

Method Summary

Methods

Modifier and Type	Method and Description
AddressBookRecord	getAddressBookRecord(Type addressBookRecordType) Gets the address book record corresponding to the given AddressBook record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getAddressBookRecord

AddressBookRecord getAddressBookRecord(Type addressBookRecordType)
                                       throws OperationFailedException

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 .

Parameters:

addressBookRecordType - the type of address book record to retrieve

Returns:

the address book record

Throws:

NullArgumentException - addressBookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(addressBookRecordType) is false

Compliance:

mandatory - This method must be implemented.