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.module.purap.businessobject.options;
017    
018    import java.util.ArrayList;
019    import java.util.Arrays;
020    import java.util.Collection;
021    import java.util.List;
022    
023    import org.kuali.kfs.module.purap.businessobject.PaymentRequestStatus;
024    import org.kuali.kfs.module.purap.businessobject.Status;
025    import org.kuali.kfs.sys.context.SpringContext;
026    import org.kuali.rice.kns.service.KeyValuesService;
027    import org.kuali.rice.core.util.KeyLabelPair;
028    
029    /**
030     * Value Finder for Payment Request Statuses.
031     */
032    public class PaymentRequestStatusValuesFinder extends PurApStatusKeyValuesBase {
033    
034        /**
035         * Overide this method to sort the PO statuses for proper display. 
036         * 
037         * @see org.kuali.kfs.module.purap.businessobject.options.PurApStatusKeyValuesBase#getKeyValues()
038         */
039        public List getKeyValues() {
040            // get all PO statuses
041            KeyValuesService boService = SpringContext.getBean(KeyValuesService.class);
042            Collection<Status> statuses = boService.findAll(getStatusClass());
043            
044            // sort the statuses according to their codes alphabetically
045            int ns = statuses.size();
046            Status[] sortStatuses = new Status[ns];
047            if ( ns > 0 ) {
048                sortStatuses = (Status[])statuses.toArray(sortStatuses);
049                Arrays.sort(sortStatuses, sortStatuses[0]);       
050            }        
051            
052            // generate output
053            List labels = new ArrayList();
054            for (Status status : sortStatuses) {
055                labels.add(new KeyLabelPair(status.getStatusCode(), status.getStatusDescription()));
056            }
057            return labels;
058        }
059        
060        /**
061         * @see org.kuali.kfs.module.purap.businessobject.options.PurApStatusKeyValuesBase#getStatusClass()
062         */
063        @Override
064        public Class getStatusClass() {
065            return PaymentRequestStatus.class;
066        }
067    }