| Interface | osid.contact.Address | ||
|---|---|---|---|
| Implements | osid.OsidObject | ||
| Description |
An | ||
| Method | getResourceId | ||
| Description |
Gets the resource | ||
| Return | osid.id.Id | a resource Id | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResource | ||
| 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. | ||
| Return | osid.resource.Resource | a resource | |
| Errors | OPERATION_FAILED | unable to complete request | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressText | ||
| Description |
Gets the textual representation of this address. | ||
| Return | osid.locale.DisplayText | the address | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAddressRecord | ||
| Description |
Gets the address record corresponding to the given
| ||
| Parameters | osid.type.Type | addressRecordType | the type of address record to retrieve |
| Return | osid.contact.records.AddressRecord | the address record | |
| Errors | NULL_ARGUMENT | addressRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(addressRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |