VisitResource1_9.java

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.module.webservices.rest.web.v1_0.resource.openmrs1_9;

import org.openmrs.Patient;
import org.openmrs.Visit;
import org.openmrs.VisitAttribute;
import org.openmrs.api.context.Context;
import org.openmrs.module.webservices.rest.SimpleObject;
import org.openmrs.module.webservices.rest.web.ConversionUtil;
import org.openmrs.module.webservices.rest.web.RequestContext;
import org.openmrs.module.webservices.rest.web.RestConstants;
import org.openmrs.module.webservices.rest.web.annotation.PropertyGetter;
import org.openmrs.module.webservices.rest.web.annotation.PropertySetter;
import org.openmrs.module.webservices.rest.web.annotation.Resource;
import org.openmrs.module.webservices.rest.web.api.RestService;
import org.openmrs.module.webservices.rest.web.representation.DefaultRepresentation;
import org.openmrs.module.webservices.rest.web.representation.FullRepresentation;
import org.openmrs.module.webservices.rest.web.representation.Representation;
import org.openmrs.module.webservices.rest.web.resource.impl.DataDelegatingCrudResource;
import org.openmrs.module.webservices.rest.web.resource.impl.DelegatingCrudResource;
import org.openmrs.module.webservices.rest.web.resource.impl.DelegatingResourceDescription;
import org.openmrs.module.webservices.rest.web.resource.impl.NeedsPaging;
import org.openmrs.module.webservices.rest.web.response.ObjectNotFoundException;
import org.openmrs.module.webservices.rest.web.response.ResourceDoesNotSupportOperationException;
import org.openmrs.module.webservices.rest.web.response.ResponseException;
import org.openmrs.module.webservices.rest.web.v1_0.resource.openmrs1_8.PatientResource1_8;

import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.Set;

/**
 * {@link Resource} for {@link Visit}, supporting standard CRUD operations
 */
@Resource(name = RestConstants.VERSION_1 + "/visit", supportedClass = Visit.class, supportedOpenmrsVersions = { "1.9.*",
        "1.10.*", "1.11.*", "1.12.*", "2.0.*", "2.1.*" })
public class VisitResource1_9 extends DataDelegatingCrudResource<Visit> {
	
	/**
	 * @see org.openmrs.module.webservices.rest.web.resource.impl.DelegatingResourceHandler#getRepresentationDescription(org.openmrs.module.webservices.rest.web.representation.Representation)
	 */
	@Override
	public DelegatingResourceDescription getRepresentationDescription(Representation rep) {
		if (rep instanceof DefaultRepresentation) {
			DelegatingResourceDescription description = new DelegatingResourceDescription();
			description.addProperty("uuid");
			description.addProperty("display");
			description.addProperty("patient", Representation.REF);
			description.addProperty("visitType", Representation.REF);
			description.addProperty("indication", Representation.REF);
			description.addProperty("location", Representation.REF);
			description.addProperty("startDatetime");
			description.addProperty("stopDatetime");
			description.addProperty("encounters", Representation.REF);
			description.addProperty("attributes", Representation.REF);
			description.addProperty("voided");
			description.addSelfLink();
			description.addLink("full", ".?v=" + RestConstants.REPRESENTATION_FULL);
			return description;
		} else if (rep instanceof FullRepresentation) {
			DelegatingResourceDescription description = new DelegatingResourceDescription();
			description.addProperty("uuid");
			description.addProperty("display");
			description.addProperty("patient", Representation.REF);
			description.addProperty("visitType", Representation.REF);
			description.addProperty("indication", Representation.REF);
			description.addProperty("location", Representation.REF);
			description.addProperty("startDatetime");
			description.addProperty("stopDatetime");
			description.addProperty("encounters", Representation.DEFAULT);
			description.addProperty("attributes", Representation.DEFAULT);
			description.addProperty("voided");
			description.addProperty("auditInfo");
			description.addSelfLink();
			return description;
		}
		return null;
	}
	
	/**
	 * Returns a display string
	 * 
	 * @param visit
	 * @return the display string
	 */
	@PropertyGetter("display")
	public String getDisplayString(Visit visit) {
		String ret = visit.getVisitType() == null ? "?" : visit.getVisitType().getName();
		ret += " ";
		ret += visit.getLocation() == null ? "?" : "@ " + visit.getLocation().getName();
		ret += " - ";
		ret += visit.getStartDatetime() == null ? "?" : Context.getDateTimeFormat().format(visit.getStartDatetime());
		return ret;
	}
	
	@PropertyGetter("attributes")
	public Collection<VisitAttribute> getActiveAttributes(Visit visit) {
		return visit.getActiveAttributes();
	}
	
	/**
	 * @see org.openmrs.module.webservices.rest.web.resource.impl.BaseDelegatingResource#getCreatableProperties()
	 */
	@Override
	public DelegatingResourceDescription getCreatableProperties() {
		DelegatingResourceDescription description = new DelegatingResourceDescription();
		description.addRequiredProperty("patient");
		description.addRequiredProperty("visitType");
		// RESTWS-488: startDatetime property to be non-mandatory
		description.addProperty("startDatetime");
		description.addProperty("location");
		description.addProperty("indication");
		description.addProperty("stopDatetime");
		description.addProperty("encounters");
		description.addProperty("attributes");
		
		return description;
	}
	
	/**
	 * @see org.openmrs.module.webservices.rest.web.resource.impl.BaseDelegatingResource#getUpdatableProperties()
	 */
	@Override
	public DelegatingResourceDescription getUpdatableProperties() throws ResourceDoesNotSupportOperationException {
		DelegatingResourceDescription description = super.getUpdatableProperties();
		//shouldn't be editing the patient
		description.removeProperty("patient");
		return description;
	}
	
	/**
	 * @see DelegatingCrudResource#newDelegate()
	 */
	@Override
	public Visit newDelegate() {
		return new Visit();
	}
	
	@Override
	public Object create(SimpleObject propertiesToCreate, RequestContext context) throws ResponseException {
		// RESTWS-488: set startDatetime if not provided
		if (propertiesToCreate.get("startDatetime") == null) {
			propertiesToCreate.add("startDatetime", new Date());
		}
		return super.create(propertiesToCreate, context);
	};
	
	/**
	 * @see DelegatingCrudResource#save(java.lang.Object)
	 */
	@Override
	public Visit save(Visit visit) {
		return Context.getVisitService().saveVisit(visit);
	}
	
	/**
	 * Fetches a visit by uuid
	 * 
	 * @see DelegatingCrudResource#getByUniqueId(java.lang.String)
	 */
	@Override
	public Visit getByUniqueId(String uuid) {
		return Context.getVisitService().getVisitByUuid(uuid);
	}
	
	/**
	 * @see org.openmrs.module.webservices.rest.web.resource.impl.DelegatingCrudResource#delete(org.openmrs.Encounter,
	 *      java.lang.String, org.openmrs.module.webservices.rest.web.RequestContext)
	 */
	@Override
	public void delete(Visit visit, String reason, RequestContext context) throws ResponseException {
		if (visit.isVoided()) {
			// Makes no sense, so we return success here
			return;
		}
		Context.getVisitService().voidVisit(visit, reason);
	}
	
	/**
	 * @see org.openmrs.module.webservices.rest.web.resource.impl.DelegatingCrudResource#purge(java.lang.Object,
	 *      org.openmrs.module.webservices.rest.web.RequestContext)
	 */
	@Override
	public void purge(Visit visit, RequestContext context) throws ResponseException {
		if (visit == null)
			return;
		Context.getVisitService().purgeVisit(visit);
	}
	
	/**
	 * @see org.openmrs.module.webservices.rest.web.resource.impl.BaseDelegatingResource#getResourceVersion()
	 */
	@Override
	public String getResourceVersion() {
		return "1.9";
	}
	
	/**
	 * Sets the attributes of a visit
	 * 
	 * @param visit the visit whose attributes to set
	 * @param attributes the attributes to set
	 */
	@PropertySetter("attributes")
	public static void setAttributes(Visit visit, Set<VisitAttribute> attributes) {
		for (VisitAttribute attribute : attributes) {
			attribute.setOwner(visit);
		}
		visit.setAttributes(attributes);
	}
	
	/**
	 * @see org.openmrs.module.webservices.rest.web.resource.impl.DelegatingCrudResource#search(org.openmrs.module.webservices.rest.web.RequestContext)
	 */
	@Override
	public SimpleObject search(RequestContext context) throws ResponseException {
		String patientParameter = context.getRequest().getParameter("patient");
		String includeInactiveParameter = context.getRequest().getParameter("includeInactive");
		String fromStartDate = context.getRequest().getParameter("fromStartDate");
		if (patientParameter != null || includeInactiveParameter != null) {
			Date minStartDate = fromStartDate != null ? (Date) ConversionUtil.convert(fromStartDate, Date.class) : null;
			return getVisits(context, patientParameter, includeInactiveParameter, minStartDate);
		} else {
			return super.search(context);
		}
	}
	
	private SimpleObject getVisits(RequestContext context, String patientParameter, String includeInactiveParameter,
	        Date minStartDate) {
		Collection<Patient> patients = patientParameter == null ? null : Arrays.asList(getPatient(patientParameter));
		boolean includeInactive = includeInactiveParameter == null ? true : Boolean.parseBoolean(includeInactiveParameter);
		return new NeedsPaging<Visit>(Context.getVisitService().getVisits(null, patients, null, null, minStartDate, null,
		    null, null, null, includeInactive, false), context).toSimpleObject(this);
	}
	
	/**
	 * Get all the visits
	 * 
	 * @see org.openmrs.module.webservices.rest.web.resource.impl.DelegatingCrudResource#doGetAll(org.openmrs.module.webservices.rest.web.RequestContext)
	 */
	@Override
	protected NeedsPaging<Visit> doGetAll(RequestContext context) {
		return new NeedsPaging<Visit>(Context.getVisitService().getAllVisits(), context);
	}
	
	private Patient getPatient(String patientUniqueId) {
		Patient patient = ((PatientResource1_8) Context.getService(RestService.class).getResourceByName(
		    RestConstants.VERSION_1 + "/patient")).getByUniqueId(patientUniqueId);
		if (patient == null)
			throw new ObjectNotFoundException();
		return patient;
	}
}