MrrtReportTemplateSearchHandler.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.radiology.report.template.web.search;

import java.util.Arrays;
import java.util.List;

import org.openmrs.module.radiology.report.template.MrrtReportTemplate;
import org.openmrs.module.radiology.report.template.MrrtReportTemplateSearchCriteria;
import org.openmrs.module.radiology.report.template.MrrtReportTemplateService;
import org.openmrs.module.webservices.rest.web.RequestContext;
import org.openmrs.module.webservices.rest.web.RestConstants;
import org.openmrs.module.webservices.rest.web.resource.api.PageableResult;
import org.openmrs.module.webservices.rest.web.resource.api.SearchConfig;
import org.openmrs.module.webservices.rest.web.resource.api.SearchHandler;
import org.openmrs.module.webservices.rest.web.resource.api.SearchQuery;
import org.openmrs.module.webservices.rest.web.resource.impl.EmptySearchResult;
import org.openmrs.module.webservices.rest.web.resource.impl.NeedsPaging;
import org.openmrs.module.webservices.rest.web.response.ResponseException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * Find MrrtReportTemplate's that match the specified search phrase.
 */
@Component
public class MrrtReportTemplateSearchHandler implements SearchHandler {
    
    
    public static final String REQUEST_PARAM_TITLE = "title";
    
    public static final String REQUEST_PARAM_PUBLISHER = "publisher";
    
    public static final String REQUEST_PARAM_TOTAL_COUNT = "totalCount";
    
    public static final String REQUEST_PARAM_LICENSE = "license";
    
    public static final String REQUEST_PARAM_CREATOR = "creator";
    
    @Autowired
    private MrrtReportTemplateService mrrtReportTemplateService;
    
    SearchQuery searchQuery = new SearchQuery.Builder("Allows you to search for MrrtReportTemplate's by title")
            .withOptionalParameters(new String[] { REQUEST_PARAM_TITLE, REQUEST_PARAM_PUBLISHER, REQUEST_PARAM_LICENSE,
                    REQUEST_PARAM_CREATOR, REQUEST_PARAM_TOTAL_COUNT })
            .build();
    
    private final SearchConfig searchConfig = new SearchConfig("default", RestConstants.VERSION_1 + "/mrrtreporttemplate",
            Arrays.asList("2.0.*"), searchQuery);
    
    /**
     * @see org.openmrs.module.webservices.rest.web.resource.api.SearchHandler#getSearchConfig()
     */
    @Override
    public SearchConfig getSearchConfig() {
        return this.searchConfig;
    }
    
    /**
     * @see org.openmrs.module.webservices.rest.web.resource.api.SearchHandler#getSearchConfig()
     * @should return all report templates that match given title
     * @should return empty search result if title does not exist
     * @should return all mrrt templates that match given title and totalCount if requested
     * @should return all report templates by given publisher
     * @should return empty search result if publisher does not exist
     * @should return all report templates that match given license
     * @should return empty search result if license does not exist
     * @should return all report templates that match given creator
     * @should return empty search result if creator does not exist
     */
    @Override
    public PageableResult search(RequestContext context) throws ResponseException {
        
        final String templateTitle = context.getParameter("title");
        final String publisher = context.getParameter("publisher");
        final String templateLicense = context.getParameter("license");
        final String templateCreator = context.getParameter("creator");
        
        final MrrtReportTemplateSearchCriteria searchCriteria =
                new MrrtReportTemplateSearchCriteria.Builder().withTitle(templateTitle)
                        .withPublisher(publisher)
                        .withLicense(templateLicense)
                        .withCreator(templateCreator)
                        .build();
        
        final List<MrrtReportTemplate> result = mrrtReportTemplateService.getMrrtReportTemplates(searchCriteria);
        if (result.isEmpty()) {
            return new EmptySearchResult();
        } else {
            return new NeedsPaging<MrrtReportTemplate>(result, context);
        }
    }
}