org.phenotips.messaging

Class Connection

java.lang.Object

org.phenotips.messaging.Connection

@Entity
public class Connection
extends Object

Stores a connection between the owners of two matched patients, anonymously, to be used for email communication. The identities of the two parties are kept private, since mails are sent behind the scenes, while the users only see the identifier of the connection.

Since:

1.0M1

Version:

$Id: 7f7a91a2e03b83c127574f710367c6892a3effba $

Constructor Summary

Constructors

Constructor and Description
Connection() Default constructor used by Hibernate.
Connection(PatientSimilarityView patientPair) Constructor that copies the data from a patient pair.

Method Summary

Methods

Modifier and Type	Method and Description
org.xwiki.model.reference.DocumentReference	getContactedUser() The target of the communication, the owner of the matched patient.
Long	getId() Deprecated. use getToken() instead
org.xwiki.model.reference.DocumentReference	getInitiatingUser() The user that initiated the communication, one of the owners of the reference patient.
org.phenotips.data.Patient	getReferencePatient() The reference patient, owned by the initiating user.
org.phenotips.data.Patient	getTargetPatient() The matched patient, owned by the contacted user.
String	getToken() The unique, secure connection token is exposed, and is the only thing needed to retrieve back the full connection.
void	setContactedUser(org.xwiki.model.reference.DocumentReference userReference) Sets the contacted user.
void	setInitiatingUser(org.xwiki.model.reference.DocumentReference userReference) Sets the initiating user.
void	setReferencePatient(org.phenotips.data.Patient patient) Sets the reference patient.
void	setTargetPatient(org.phenotips.data.Patient patient) Sets the matched patient.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Connection

public Connection()

Default constructor used by Hibernate.

Connection

public Connection(PatientSimilarityView patientPair)

Constructor that copies the data from a patient pair.

Parameters:

patientPair - the paired patient to get the data from

Method Detail

getId

@Deprecated
public Long getId()

Deprecated. use getToken() instead

The identifier of this connection can be exposed, and is the only thing needed to retrieve back the full connection.

Returns:

a numerical identifier

getToken

public String getToken()

The unique, secure connection token is exposed, and is the only thing needed to retrieve back the full connection.

Returns:

a string token

getInitiatingUser

public org.xwiki.model.reference.DocumentReference getInitiatingUser()

The user that initiated the communication, one of the owners of the reference patient.

Returns:

a user reference

setInitiatingUser

public void setInitiatingUser(org.xwiki.model.reference.DocumentReference userReference)

Sets the initiating user.

Parameters:

userReference - the user reference to store

getContactedUser

public org.xwiki.model.reference.DocumentReference getContactedUser()

The target of the communication, the owner of the matched patient.

Returns:

a user reference

setContactedUser

public void setContactedUser(org.xwiki.model.reference.DocumentReference userReference)

Sets the contacted user.

Parameters:

userReference - the user reference to store

getReferencePatient

public org.phenotips.data.Patient getReferencePatient()

The reference patient, owned by the initiating user.

Returns:

a patient

setReferencePatient

public void setReferencePatient(org.phenotips.data.Patient patient)

Sets the reference patient.

Parameters:

patient - the reference patient to store

getTargetPatient

public org.phenotips.data.Patient getTargetPatient()

The matched patient, owned by the contacted user.

Returns:

a patient, usually with only partial information exposed

setTargetPatient

public void setTargetPatient(org.phenotips.data.Patient patient)

Sets the matched patient.

Parameters:

patient - the matched patient to store

toString

public String toString()

Overrides:

toString in class Object