RestService.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.api;

import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.servlet.http.HttpServletRequest;

import org.openmrs.api.APIException;
import org.openmrs.module.webservices.rest.web.representation.Representation;
import org.openmrs.module.webservices.rest.web.resource.api.Resource;
import org.openmrs.module.webservices.rest.web.resource.api.SearchHandler;
import org.openmrs.module.webservices.rest.web.resource.impl.DelegatingResourceHandler;

/**
 * Database related methods for the Rest Web Services
 */
public interface RestService {
	
	/**
	 * Parses a representation requested by the client via the http request
	 * 
	 * @param requested
	 * @return
	 * @should get ref representation when specified
	 * @should get default representation when specified
	 * @should get full representation when specified
	 * @should get a named representation when specified
	 */
	public Representation getRepresentation(String requested);
	
	Resource getResourceByName(String name) throws APIException;
	
	/**
	 * Auto generated method comment
	 * 
	 * @param supportedClass
	 * @return
	 * @throws APIException
	 */
	Resource getResourceBySupportedClass(Class<?> supportedClass) throws APIException;
	
	/**
	 * Returns a search handler, which supports the given resource and the map of parameters and
	 * values.
	 * 
	 * @param resourceName
	 * @param parameters
	 * @return searchHandler or <code>null</code> if no match
	 * @throws APIException
	 */
	SearchHandler getSearchHandler(String resourceName, Map<String, String[]> parameters) throws APIException;
	
	/**
	 * Returns all search handlers supporting a resource
	 * 
	 * @param resourceName
	 * @return
	 */
	Set<SearchHandler> getSearchHandlers(String resourceName);
	
	/**
	 * Returns all {@link DelegatingResourceHandler}s
	 * 
	 * @return list of {@link DelegatingResourceHandler}s
	 * @throws APIException
	 */
	public List<DelegatingResourceHandler<?>> getResourceHandlers() throws APIException;
	
	/**
	 * Initializes all Resources and Search handlers for use; called after module startup
	 */
	public void initialize();
	
	/**
	 * Returns all search handlers.
	 * 
	 * @return all search handlers or <code>null</code> if none registered
	 */
	public List<SearchHandler> getAllSearchHandlers();
}