Interface Address

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface Address extends OsidObject

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.

Like all OsidObjects, Address is managed by its OsidSessions and may not be accessed by concurrent processing threads.

  • Method Details

    • getResourceId

      Id getResourceId()
      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.
      Returns:
      a resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getResource

      Resource getResource() throws OperationFailedException
      Gets the resource to which this address belongs. All addresses belong to one resource but may be used for contacts among multiple other resources.
      Returns:
      a resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAddressText

      DisplayText getAddressText()
      Gets the textual representation of this address.
      Returns:
      the address
      Compliance:
      mandatory - This method must be implemented.

    • getAddressRecord

      AddressRecord getAddressRecord(Type addressRecordType) throws OperationFailedException
      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.
      Parameters:
      addressRecordType - the type of address record to retrieve
      Returns:
      the address record
      Throws:
      NullArgumentException - addressRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(addressRecordType) is false
      Compliance:
      mandatory - This method must be implemented.