org.phenotips.data.rest

Interface DomainObjectFactory

@Unstable
@Role
public interface DomainObjectFactory

Factory class for generating REST representations of various types of entities.

Since:

1.2M5

Version:

$Id: 68c040001e30ae6e7c8d61e7c9c3e6fcecb2b7ca $

Method Summary

Methods

Modifier and Type	Method and Description
Alternative	createAlternative(String id, javax.ws.rs.core.UriInfo uriInfo) Create the REST representation for a link to a Patient.
Alternatives	createAlternatives(List<String> alternativeIdentifiers, javax.ws.rs.core.UriInfo uriInfo) Create the REST representation for a list of links to Patients.
PatientSummary	createPatientSummary(Object[] summaryData, javax.ws.rs.core.UriInfo uriInfo) Create the REST representation for a Patient's summary, starting from the raw values needed for the summary.
PatientSummary	createPatientSummary(Patient patient, javax.ws.rs.core.UriInfo uriInfo) Create the REST representation for a Patient's summary, starting from an actual Patient object.

Method Detail

createPatientSummary

PatientSummary createPatientSummary(Patient patient,
                                  javax.ws.rs.core.UriInfo uriInfo)

Create the REST representation for a Patient's summary, starting from an actual Patient object.

Parameters:

patient - the patient to serialize

uriInfo - the URI information for the rest system and the current request

Returns:

a patient summary, or null if the current user doesn't have access to the patient or accessing the patient data fails

createPatientSummary

PatientSummary createPatientSummary(Object[] summaryData,
                                  javax.ws.rs.core.UriInfo uriInfo)

Create the REST representation for a Patient's summary, starting from the raw values needed for the summary.

Parameters:

summaryData - the needed patient information to serialize, in order: document name, external identifier, creator, creation date, current version, last author, last modification date

uriInfo - the URI information for the rest system and the current request

Returns:

a patient summary, or null if the current user doesn't have access to the patient or accessing the patient data fails

createAlternatives

Alternatives createAlternatives(List<String> alternativeIdentifiers,
                              javax.ws.rs.core.UriInfo uriInfo)

Create the REST representation for a list of links to Patients.

Parameters:

alternativeIdentifiers - the identifiers of the patients to link to

uriInfo - the URI information for the rest system and the current request

Returns:

a list of links to the REST address for accessing each patient record accessible to the current user; may be empty

createAlternative

Alternative createAlternative(String id,
                            javax.ws.rs.core.UriInfo uriInfo)

Create the REST representation for a link to a Patient.

Parameters:

id - the identifier of the patient to link to

uriInfo - the URI information for the rest system and the current request

Returns:

a link to the REST address for accessing the patient record