org.phenotips.data

Interface ContactInfo

@Unstable(value="New API introduced in 1.3")
public interface ContactInfo

The information about a contact person/organization for a patient record.

Since:

1.3

Version:

$Id: 24cd9def89a6e2328716a2f60e78f0d3c8ed4b69 $

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ContactInfo.Builder Builder for ContactInfo objects.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getEmails() Get the contact's email addresses.
String	getInstitution() Get the contact's institution.
String	getName() Get the contact's full name.
String	getUrl() Get the contact's URL.
String	getUserId() Get the user id for the contact, for instance if the owner is a local PhenoTips user.
org.json.JSONObject	toJSON() Get the contact details in JSON format.

Method Detail

getUserId

String getUserId()

Get the user id for the contact, for instance if the owner is a local PhenoTips user.

Returns:

the (potentially-null) user id

getName

String getName()

Get the contact's full name.

Returns:

the (potentially-null) full name of the contact

getInstitution

String getInstitution()

Get the contact's institution.

Returns:

the (potentially-null) institution of the contact

getEmails

List<String> getEmails()

Get the contact's email addresses.

Returns:

the list of the contact's email addresses, may be empty but not null

getUrl

String getUrl()

Get the contact's URL.

Returns:

the (potentially-null) URL for the contact

toJSON

org.json.JSONObject toJSON()

Get the contact details in JSON format.

Returns:

a JSONObject serialization of the contact details