/**

  * Copyright 2005-2011 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  * http://www.opensource.org/licenses/ecl2.php

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.location.api.country;

 import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;

 import org.kuali.rice.core.api.exception.RiceIllegalStateException;

 import org.kuali.rice.location.api.LocationConstants;

 import org.springframework.cache.annotation.Cacheable;

 import javax.jws.WebMethod;

 import javax.jws.WebParam;

 import javax.jws.WebResult;

 import javax.jws.WebService;

 import javax.jws.soap.SOAPBinding;

 import java.util.List;

 /**

  * <p>CountryService interface.</p>

  *

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 @WebService(name = "CountryService", targetNamespace = LocationConstants.Namespaces.LOCATION_NAMESPACE_2_0)

 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)

 public interface CountryService {

     /**

      * Lookup a country object based on the given country code.

      *

      * @param code the given country code

      * @return a country object with the given country code.  A null reference is returned if an invalid or

      *         non-existant code is supplied.

      */

     @WebMethod(operationName = "getCountry")

     @WebResult(name = "country")

     @Cacheable(value=Country.Cache.NAME, key="'code=' + #p0")

     Country getCountry(@WebParam(name = "code") String code) throws RiceIllegalArgumentException;

     /**

      * Get a country object based on an alternate country code

      *

      * @param alternateCode the given alternate country code

      * @return A country object with the given alternate country code if a country with that alternate country code

      *         exists.  Otherwise, null is returned.

      * @throws IllegalStateException if multiple Countries exist with the same passed in alternateCode

      * @throws IllegalArgumentException if alternateCode is null or is a whitespace only string.

      */

     @WebMethod(operationName = "getCountryByAlternateCode")

     @WebResult(name = "country")

     @Cacheable(value=Country.Cache.NAME, key="'alternateCode=' + #p0")

     Country getCountryByAlternateCode(@WebParam(name = "alternateCode") String alternateCode)

             throws RiceIllegalStateException, RiceIllegalArgumentException;

     /**

      * Returns all Countries that are not restricted.

      *

      * @return all countries that are not restricted

      */

     @WebMethod(operationName = "findAllCountriesNotRestricted")

     @WebResult(name = "countriesNotRestricted")

     @Cacheable(value=Country.Cache.NAME, key="'allRestricted'")

     List<Country> findAllCountriesNotRestricted();

     /**

      * Returns all Countries

      *

      * @return all countries

      */

     @WebMethod(operationName = "findAllCountries")

     @WebResult(name = "allCountries")

     @Cacheable(value=Country.Cache.NAME, key="'all'")

     List<Country> findAllCountries();

 }