001/**
002 * Copyright 2005-2017 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.kew.impl.document.search;
017
018import org.kuali.rice.core.api.util.ConcreteKeyValue;
019import org.kuali.rice.core.api.util.KeyValue;
020import org.kuali.rice.kew.api.document.DocumentStatus;
021import org.kuali.rice.kew.api.document.DocumentStatusCategory;
022import org.kuali.rice.krad.keyvalues.KeyValuesBase;
023
024import java.util.ArrayList;
025import java.util.List;
026import java.util.Set;
027
028/**
029 * A values finder implementation that loads the various workflow document status categories and their individual
030 * statuses.
031 *
032 * @author Kuali Rice Team (rice.collab@kuali.org)
033 */
034public class DocumentStatusValuesFinder extends KeyValuesBase {
035
036    private static final String CATEGORY_CODE_PREFIX = "category:";
037
038    @Override
039    public List<KeyValue> getKeyValues() {
040        List<KeyValue> statuses = new ArrayList<KeyValue>();
041        addCategory(statuses, DocumentStatusCategory.PENDING);
042        addCategory(statuses, DocumentStatusCategory.SUCCESSFUL);
043        addCategory(statuses, DocumentStatusCategory.UNSUCCESSFUL);
044        return statuses;
045    }
046
047    private void addCategory(List<KeyValue> statuses, DocumentStatusCategory category) {
048        statuses.add(new ConcreteKeyValue(CATEGORY_CODE_PREFIX + category.getCode(), category.getLabel() + " Statuses"));
049        Set<DocumentStatus> documentStatuses = DocumentStatus.getStatusesForCategory(category);
050        for (DocumentStatus documentStatus : documentStatuses) {
051            statuses.add(new ConcreteKeyValue(documentStatus.getCode(), "- " + documentStatus.getLabel()));
052        }
053    }
054}