/**

  * 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.county;

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

 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 javax.xml.bind.annotation.XmlElement;

 import javax.xml.bind.annotation.XmlElementWrapper;

 import java.util.List;

 /**

  * <p>CountyService interface.</p>

  *

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

  */

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

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

 public interface CountyService {

     /**

      * Gets a {@link County} from a postal country code and postal code value.

      * <p/>

      * <p>

      * This method will return null if the state does not exist.

      * </p>

      * <p/>

      * <p>

      * This method will return active or inactive counties.

      * </p>

      *

      * @param countryCode country code. cannot be blank.

      * @param stateCode   postal state code. cannot be blank.

      * @param code        county code. cannot be blank

      * @return a {@link County} or null

      * @throws IllegalArgumentException country code, postal state code, or county code is blank

      */

     @WebMethod(operationName = "getCounty")

     @WebResult(name = "county")

     @Cacheable(value=County.Cache.NAME, key="'countryCode=' + #p0 + '|' + 'stateCode=' + #p1 + '|' + 'code=' + #p3")

     County getCounty(@WebParam(name = "countryCode") String countryCode, @WebParam(name = "stateCode") String stateCode, @WebParam(name = "code") String code)

             throws RiceIllegalArgumentException;

     /**

      * Gets all the {@link County County} for postal country code & postal state code.

      * <p/>

      * <p>

      * This method will always return an <b>immutable</b> Collection

      * even when no values exist.

      * </p>

      * <p/>

      * <p>

      * This method will only return active counties.

      * </p>

      *

      * @param countryCode state code. cannot be blank.

      * @param stateCode   postal state code. cannot be blank.

      * @return an immutable collection of counties

      * @throws IllegalArgumentException country code, postal state code is blank

      */

     @WebMethod(operationName = "findAllCountiesInCountryAndState")

     @XmlElementWrapper(name = "counties", required = true)

     @XmlElement(name = "county", required = false)

     @WebResult(name = "counties")

     @Cacheable(value=County.Cache.NAME, key="'countryCode=' + #p0 + '|' + 'stateCode=' + #p1")

     List<County> findAllCountiesInCountryAndState(@WebParam(name = "countryCode") String countryCode, @WebParam(name = "stateCode") String stateCode)

             throws RiceIllegalArgumentException;

 }