Interface Contact

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Contact extends OsidRelationship

A Contact relates a reference Id to an address and addresse. The contact addressee is expressed as a Resource . For example, a contact for a Repository would have the repository Id as the reference, and the person to contact as the addressee. When specifying Contacts for external Resources , the reference Id and the addressee may be the same.

Multiple contacts may be related to an Id sorted by priority. A Contact is available for use on the specified weekdays and within a time of day. The genus Type of the Contact may be used to provide further detail on how the context or usage of this Contact .

  • Method Details

    • getReferenceId

      Id getReferenceId()
      Gets the Id of the reference.
      Returns:
      the reference Id
      Compliance:
      mandatory - This method must be implemented.

    • getAddresseeId

      Id getAddresseeId()
      Gets the Id of the addressee.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getAddressee

      Resource getAddressee() throws OperationFailedException
      Gets the addressee.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAddressId

      Id getAddressId()
      Gets the Id of the subscriber's address.
      Returns:
      the subscriber Id
      Compliance:
      mandatory - This method must be implemented.

    • getAddress

      Address getAddress() throws OperationFailedException
      Gets the subscriber's address.
      Returns:
      the subscriber's address.
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getContactRecord

      ContactRecord getContactRecord(Type contactRecordType) throws OperationFailedException
      Gets the contact record corresponding to the given Contact record Type .This method is used to retrieve an object implementing the requested record. The contactRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(contactRecordType) is true .
      Parameters:
      contactRecordType - the type of contact record to retrieve
      Returns:
      the contact record
      Throws:
      NullArgumentException - contactRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(contactRecordType) is false
      Compliance:
      mandatory - This method must be implemented.