ProviderSearchLookupService.java

/*******************************************************************************
 * Open Behavioral Health Information Technology Architecture (OBHITA.org)
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/
package gov.samhsa.consent2share.service.provider;

import org.springframework.security.access.annotation.Secured;

/**
 * The Interface ProviderSearchLookupService.
 */
@Secured({ "ROLE_USER", "ROLE_ADMIN" })
public interface ProviderSearchLookupService {

	/**
	 * Gets the provider search url.
	 *
	 * @return the provider search url
	 */
	public String getProviderSearchURL();

	/**
	 * Sets the provider search url.
	 *
	 * @param providerSearchURL
	 *            the new provider search url
	 */
	public void setProviderSearchURL(String providerSearchURL);

	/**
	 * Provider search.
	 *
	 * @param usstate
	 *            the usstate
	 * @param city
	 *            the city
	 * @param zipcode
	 *            the zipcode
	 * @param gender
	 *            the gender
	 * @param specialty
	 *            the specialty
	 * @param phone
	 *            the phone
	 * @param firstname
	 *            the firstname
	 * @param lastname
	 *            the lastname
	 * @param facilityName
	 *            the facility name
	 * @param pageNumber
	 *            the page number
	 * @return the string
	 */
	public String providerSearch(String usstate, String city, String zipcode,
			String gender, String specialty, String phone, String firstname,
			String lastname, String facilityName, int pageNumber);

	/**
	 * Provider search.
	 *
	 * @param usstate
	 *            the usstate
	 * @param city
	 *            the city
	 * @param zipcode
	 *            the zipcode
	 * @param gender
	 *            the gender
	 * @param specialty
	 *            the specialty
	 * @param phone
	 *            the phone
	 * @param firstname
	 *            the firstname
	 * @param lastnameOrFacilityName
	 *            the lastname or facility name
	 * @param pageNumber
	 *            the page number
	 * @return the string
	 */
	public String providerSearch(String usstate, String city, String zipcode,
			String gender, String specialty, String phone, String firstname,
			String lastnameOrFacilityName, int pageNumber);

	/**
	 * Generate provider search url.
	 *
	 * @param usstate
	 *            the usstate
	 * @param city
	 *            the city
	 * @param zipcode
	 *            the zipcode
	 * @param gender
	 *            the gender
	 * @param specialty
	 *            the specialty
	 * @param phone
	 *            the phone
	 * @param firstname
	 *            the firstname
	 * @param lastname
	 *            the lastname
	 * @param facilityName
	 *            the facility name
	 * @param pageNumber
	 *            the page number
	 * @return the string
	 */
	public String generateProviderSearchURL(String usstate, String city,
			String zipcode, String gender, String specialty, String phone,
			String firstname, String lastname, String facilityName,
			int pageNumber);

	/**
	 * Generate provider search url.
	 *
	 * @param usstate
	 *            the usstate
	 * @param city
	 *            the city
	 * @param zipcode
	 *            the zipcode
	 * @param gender
	 *            the gender
	 * @param specialty
	 *            the specialty
	 * @param phone
	 *            the phone
	 * @param firstname
	 *            the firstname
	 * @param lastnameOrFacilityName
	 *            the lastname or facility name
	 * @param pageNumber
	 *            the page number
	 * @return the string
	 */
	public String generateProviderSearchURL(String usstate, String city,
			String zipcode, String gender, String specialty, String phone,
			String firstname, String lastnameOrFacilityName, int pageNumber);

	/**
	 * Call provider search.
	 *
	 * @param query
	 *            the query
	 * @return the string
	 */
	public String callProviderSearch(String query);

	/**
	 * Checks if is validated search.
	 *
	 * @param usstate
	 *            the usstate
	 * @param city
	 *            the city
	 * @param zipcode
	 *            the zipcode
	 * @param gender
	 *            the gender
	 * @param specialty
	 *            the specialty
	 * @param phone
	 *            the phone
	 * @param firstname
	 *            the firstname
	 * @param lastname
	 *            the lastname
	 * @param facilityName
	 *            the facility name
	 * @return true, if is validated search
	 */
	boolean isValidatedSearch(String usstate, String city, String zipcode,
			String gender, String specialty, String phone, String firstname,
			String lastname, String facilityName);

	/**
	 * Provider search by npi.
	 *
	 * @param npi
	 *            the npi
	 * @return the string
	 */
	public String providerSearchByNpi(String npi);
}