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 ValueFinder that allows inquirers to include no pending entries, approved pending entries,
028     * or all pending entries in the results of their lookup
029     */
030    public class PendingEntryOptionFinder extends KeyValuesBase implements ValueFinder {
031    
032        /**
033         * Returns a list of key/value pairs for this ValueFinder, in this case no pending entries, approved pending entries, and all pending entries
034         * @return a List of key/value pairs to populate a control
035         * @see org.kuali.rice.kns.lookup.keyvalues.KeyValuesFinder#getKeyValues()
036         */
037        public List getKeyValues() {
038    
039            List labels = new ArrayList();
040            labels.add(new KeyLabelPair(Constant.NO_PENDING_ENTRY, Constant.NO_PENDING_ENTRY));
041            labels.add(new KeyLabelPair(Constant.APPROVED_PENDING_ENTRY, Constant.APPROVED_PENDING_ENTRY));
042            labels.add(new KeyLabelPair(Constant.ALL_PENDING_ENTRY, Constant.ALL_PENDING_ENTRY));
043    
044            return labels;
045        }
046    
047        /**
048         * Returns the default value for this ValueFinder, in this case no pending entries
049         * @return the key of the default value
050         * @see org.kuali.rice.kns.lookup.valueFinder.ValueFinder#getValue()
051         */
052        public String getValue() {
053            return Constant.NO_PENDING_ENTRY;
054        }
055    }