001/**
002 * Copyright 2005-2015 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.location.impl.country;
017
018
019import org.apache.commons.lang.StringUtils;
020import org.kuali.rice.core.api.criteria.QueryByCriteria;
021import org.kuali.rice.core.api.criteria.QueryResults;
022import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
023import org.kuali.rice.core.api.exception.RiceIllegalStateException;
024import org.kuali.rice.coreservice.framework.parameter.ParameterService;
025import org.kuali.rice.krad.data.DataObjectService;
026import org.kuali.rice.krad.util.KRADConstants;
027import org.kuali.rice.krad.util.KRADPropertyConstants;
028import org.kuali.rice.location.api.LocationConstants;
029import org.kuali.rice.location.api.country.Country;
030import org.kuali.rice.location.api.country.CountryQueryResults;
031import org.kuali.rice.location.api.country.CountryService;
032import org.springframework.beans.factory.annotation.Required;
033
034import java.util.ArrayList;
035import java.util.Collection;
036import java.util.Collections;
037import java.util.HashMap;
038import java.util.List;
039import java.util.Map;
040
041public final class CountryServiceImpl implements CountryService {
042    private ParameterService parameterService;
043    private DataObjectService dataObjectService;
044
045    @Override
046    public Country getCountry(final String code) {
047        if (StringUtils.isBlank(code)) {
048            throw new RiceIllegalArgumentException("code is blank");
049        }
050        CountryBo countryBo = getDataObjectService().find(CountryBo.class,code);
051        return CountryBo.to(countryBo);
052    }
053
054    @Override
055    public Country getCountryByAlternateCode(final String alternateCode) {
056        if (StringUtils.isBlank(alternateCode)) {
057            throw new RiceIllegalArgumentException("alt code is blank");
058        }
059        QueryByCriteria qbc = QueryByCriteria.Builder.forAttribute(KRADPropertyConstants.ALTERNATE_POSTAL_COUNTRY_CODE,
060                alternateCode).build();
061        QueryResults<CountryBo> countryBoQueryResults = getDataObjectService().findMatching(CountryBo.class,qbc);
062        List<CountryBo> countryList = countryBoQueryResults.getResults();
063        if (countryList == null || countryList.isEmpty()) {
064            return null;
065        } else if (countryList.size() == 1) {
066            return CountryBo.to(countryList.iterator().next());
067        } else throw new RiceIllegalStateException("Multiple countries found with same alternateCode");
068    }
069
070    @Override
071    public List<Country> findAllCountriesNotRestricted() {
072        List<Boolean> criteriaValues = new ArrayList<Boolean>();
073        criteriaValues.add(null);
074        criteriaValues.add(Boolean.FALSE);
075
076        final Map<String, Object> map = new HashMap<String, Object>();
077
078        map.put(KRADPropertyConstants.POSTAL_COUNTRY_RESTRICTED_INDICATOR, criteriaValues);
079        map.put("active", Boolean.TRUE);
080        QueryResults<CountryBo> countryBos = dataObjectService.findMatching(CountryBo.class,QueryByCriteria.Builder.andAttributes(
081                map).build());
082
083        return convertListOfBosToImmutables(countryBos.getResults());
084    }
085
086    @Override
087    public List<Country> findAllCountries() {
088        QueryResults<CountryBo> countryBoQueryResults = dataObjectService.findMatching(CountryBo.class,
089                QueryByCriteria.Builder.forAttribute("active",Boolean.TRUE).build());
090        //Collection<CountryBo> countryBos = businessObjectService.findMatching(CountryBo.class, Collections.unmodifiableMap(map));
091        return convertListOfBosToImmutables(countryBoQueryResults.getResults());
092    }
093
094    @Override
095    public Country getDefaultCountry() {
096        String defaultCountryCode = parameterService.getParameterValueAsString(LocationConstants.NAMESPACE_CODE,
097                KRADConstants.DetailTypes.ALL_DETAIL_TYPE, LocationConstants.ParameterKey.DEFAULT_COUNTRY);
098        if (StringUtils.isBlank(defaultCountryCode)) {
099            return null;
100        }
101        return getCountry(defaultCountryCode);
102    }
103
104    @Override
105    public CountryQueryResults findCountries(QueryByCriteria queryByCriteria) throws RiceIllegalArgumentException {
106        incomingParamCheck(queryByCriteria, "queryByCriteria");
107
108        QueryResults<CountryBo> results = dataObjectService.findMatching(CountryBo.class, queryByCriteria);
109
110        CountryQueryResults.Builder builder = CountryQueryResults.Builder.create();
111        builder.setMoreResultsAvailable(results.isMoreResultsAvailable());
112        builder.setTotalRowCount(results.getTotalRowCount());
113
114        final List<Country.Builder> ims = new ArrayList<Country.Builder>();
115        for (CountryBo bo : results.getResults()) {
116            ims.add(Country.Builder.create(bo));
117        }
118
119        builder.setResults(ims);
120        return builder.build();
121    }
122
123    public ParameterService getParameterService() {
124        return parameterService;
125    }
126
127    public void setParameterService(ParameterService parameterService) {
128        this.parameterService = parameterService;
129    }
130
131    /**
132     * Converts a List<CountryBo> to an Unmodifiable List<Country>
133     *
134     * @param countryBos a mutable List<CountryBo> to made completely immutable.
135     * @return An unmodifiable List<Country>
136     */
137    List<Country> convertListOfBosToImmutables(final Collection<CountryBo> countryBos) {
138        ArrayList<Country> countries = new ArrayList<Country>();
139        for (CountryBo bo : countryBos) {
140            Country country = CountryBo.to(bo);
141            countries.add(country);
142        }
143        return Collections.unmodifiableList(countries);
144    }
145
146    private void incomingParamCheck(Object object, String name) {
147        if (object == null) {
148            throw new RiceIllegalArgumentException(name + " was null");
149        } else if (object instanceof String
150                && StringUtils.isBlank((String) object)) {
151            throw new RiceIllegalArgumentException(name + " was blank");
152        }
153    }
154
155
156    public DataObjectService getDataObjectService() {
157        return dataObjectService;
158    }
159    @Required
160    public void setDataObjectService(DataObjectService dataObjectService) {
161        this.dataObjectService = dataObjectService;
162    }
163
164}