OSID Logo
OSID Specifications
contact package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.Address
Implementsosid.OsidObject
Description

An Address for a Resource. The detailed components of the Address are maintained in the AddressRecord while getAddressText() supplies a usable form of the address. The genus Type of the Address indicates the kind of address such as email or phone number.

MethodgetResourceId
Description

Gets the resource Id to which this address belongs. All addresses belong to one resource but may be used for contacts among multiple other resources.

Returnosid.id.Ida resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource to which this address belongs. All addresses belong to one resource but may be used for contacts among multiple other resources.

Returnosid.resource.Resourcea resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAddressText
Description

Gets the textual representation of this address.

Returnosid.locale.DisplayTextthe address
CompliancemandatoryThis method must be implemented.
MethodgetAddressRecord
Description

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

Parametersosid.type.TypeaddressRecordTypethe type of address record to retrieve
Returnosid.contact.records.AddressRecordthe address record
ErrorsNULL_ARGUMENT addressRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(addressRecordType) is false
CompliancemandatoryThis method must be implemented.