001    /*
002     * Copyright 2011 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     */
016    package org.kuali.kfs.fp.businessobject.options;
017    
018    import java.util.ArrayList;
019    import java.util.List;
020    
021    import org.kuali.kfs.fp.businessobject.PaymentReasonCode;
022    import org.kuali.kfs.sys.KFSPropertyConstants;
023    import org.kuali.kfs.sys.context.SpringContext;
024    import org.kuali.rice.kns.lookup.keyvalues.KeyValuesBase;
025    import org.kuali.rice.kns.service.KeyValuesService;
026    import org.kuali.rice.core.util.KeyLabelPair;
027    
028    /**
029     * This class returns list of payment reason value pairs.
030     */
031    public class PaymentReasonValuesFinder extends KeyValuesBase {
032    
033        /**
034         * @see org.kuali.keyvalues.KeyValuesFinder#getKeyValues()
035         */
036        public List getKeyValues() {
037            // Retrieve all the payment reason codes
038            List<PaymentReasonCode> boList = (List<PaymentReasonCode>) SpringContext.getBean(KeyValuesService.class).findAllOrderBy(PaymentReasonCode.class, KFSPropertyConstants.NAME, true);
039            
040            List<KeyLabelPair> keyValues = new ArrayList<KeyLabelPair>();
041            keyValues.add(new KeyLabelPair("", ""));
042            for (PaymentReasonCode paymentReason : boList) {
043                if(paymentReason.isActive()) {
044                    keyValues.add(new KeyLabelPair(paymentReason.getCode(), paymentReason.getCodeAndDescription()));
045                }
046            }
047            
048            return keyValues;
049        }    
050    }