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.gl.businessobject.options;
017    
018    import java.util.ArrayList;
019    import java.util.List;
020    
021    import org.kuali.kfs.gl.Constant;
022    import org.kuali.rice.kns.lookup.keyvalues.KeyValuesBase;
023    import org.kuali.rice.kns.lookup.valueFinder.ValueFinder;
024    import org.kuali.rice.core.util.KeyLabelPair;
025    
026    /**
027     * An implementation of ValuesFinder that allows GL inquiries to select either monthly totals or accumulated totals on balance inquiries
028     */
029    public class AmountViewOptionFinder extends KeyValuesBase implements ValueFinder {
030    
031        /**
032         * Returns the default value of this ValueFinder: here, MONTHLY
033         * @return the default value for this finder, which should be "monthly totals"
034         * @see org.kuali.rice.kns.lookup.valueFinder.ValueFinder#getValue()
035         */
036        public String getValue() {
037            return Constant.MONTHLY;
038        }
039    
040        /**
041         * Returns a list of key values to populate a drop down to choose between monthly totals and accumulated totals
042         * @return a List of key value pairs
043         * @see org.kuali.rice.kns.lookup.keyvalues.KeyValuesFinder#getKeyValues()
044         */
045        public List getKeyValues() {
046            List labels = new ArrayList();
047            labels.add(new KeyLabelPair(Constant.MONTHLY, Constant.MONTHLY));
048            labels.add(new KeyLabelPair(Constant.ACCUMULATE, Constant.ACCUMULATE));
049            return labels;
050        }
051    }