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;
017    
018    
019    /**
020     * This class contains the constants being used by various general ledger components
021     */
022    public final class Constant {
023        public static final String EMPTY_STRING = "";
024    
025        public static final String PENDING_ENTRY_OPTION = "dummyBusinessObject.pendingEntryOption";
026        public static final String APPROVED_PENDING_ENTRY = "Approved";
027        public static final String ALL_PENDING_ENTRY = "All";
028        public static final String NO_PENDING_ENTRY = "No";
029    
030        public static final String CONSOLIDATION_OPTION = "dummyBusinessObject.consolidationOption";
031        public static final String CONSOLIDATION = "Consolidation";
032        public static final String DETAIL = "Detail";
033    
034        public static final String AMOUNT_VIEW_OPTION = "dummyBusinessObject.amountViewOption";
035        public static final String MONTHLY = "Monthly";
036        public static final String ACCUMULATE = "Accumulate";
037        
038        public static final String BLANK_LINE_OPTION = "dummyBusinessObject.blankLineOption";
039        public static final String SHOW_BLANK_LINE = "Yes";
040        public static final String NOT_SHOW_BLANK_LINE = "No";
041    
042        public static final String COST_SHARE_OPTION = "dummyBusinessObject.costShareOption";
043        public static final String COST_SHARE_EXCLUDE = "Exclude";
044        public static final String COST_SHARE_INCLUDE = "Include";
045    
046        public static final String SUB_ACCOUNT_OPTION = "subAccountNumber";
047    
048        public static final String DOCUMENT_APPROVED_CODE_APPROVED = "A";
049        public static final String DOCUMENT_APPROVED_CODE_PENDING = "N";
050        public static final String DOCUMENT_APPROVED_CODE_PROCESSED = "X";
051    
052        public static final String BALANCE_TYPE_PE = "PE";
053        public static final String BALANCE_TYPE_CB = "CB";
054    
055        public static final String CONSOLIDATED_SUB_ACCOUNT_NUMBER = "*ALL*";
056        public static final String CONSOLIDATED_SUB_OBJECT_CODE = "*ALL*";
057        public static final String CONSOLIDATED_OBJECT_TYPE_CODE = "*ALL*";
058    
059        public static final String GL_LOOKUPABLE_ACCOUNT_BALANCE = "glAccountBalanceLookupable";
060        public static final String GL_LOOKUPABLE_ACCOUNT_BALANCE_BY_CONSOLIDATION = "glAccountBalanceByConsolidationLookupable";
061        public static final String GL_LOOKUPABLE_ACCOUNT_BALANCE_BY_LEVEL = "glAccountBalanceByLevelLookupable";
062        public static final String GL_LOOKUPABLE_ACCOUNT_BALANCE_BY_OBJECT = "glAccountBalanceByObjectLookupable";
063        public static final String GL_LOOKUPABLE_BALANCE = "glBalanceLookupable";
064        public static final String GL_LOOKUPABLE_CASH_BALANCE = "glCashBalanceLookupable";
065        public static final String GL_LOOKUPABLE_ENCUMBRANCE = "glEncumbranceLookupable";
066        public static final String GL_LOOKUPABLE_ENTRY = "glEntryLookupable";
067        public static final String GL_LOOKUPABLE_PENDING_ENTRY = "glPendingEntryLookupable";
068    
069        public static final String RETURN_LOCATION_VALUE = "portal.do";
070        public static final String START_CHAR_OF_REPORTING_SORT_CODE_B = "B";
071        public static final String LOOKUP_BUTTON_VALUE = "Drill Down";
072    
073        public static final String TOTAL_ACCOUNT_BALANCE_INCOME = "Income";
074        public static final String TOTAL_ACCOUNT_BALANCE_EXPENSE_GROSS = "Expense (Gross)";
075        public static final String TOTAL_ACCOUNT_BALANCE_EXPENSE_IN = "Expense (Net Transfer In)";
076        public static final String TOTAL_ACCOUNT_BALANCE_AVAILABLE = "Avaliable Balance";
077    
078        public static final String SEARCH_RESULTS = "searchResults";
079        
080        public enum DocumentApprovedCode{
081            APPROVED(DOCUMENT_APPROVED_CODE_APPROVED, "APPROVED"), PENDING(DOCUMENT_APPROVED_CODE_PENDING, "PENDING"), PROCESSED(DOCUMENT_APPROVED_CODE_PROCESSED, "PROCESSED");
082            
083            public String code;
084            public String description;
085            private DocumentApprovedCode(String code, String description) {
086                this.code = code;
087                this.description = description;
088            }
089            
090            public static String getDescription(String code) {
091                for(DocumentApprovedCode approvedCode : DocumentApprovedCode.values()) {
092                    if(approvedCode.code.equals(code)) {
093                        return approvedCode.description;
094                    }
095                }
096                
097                return null;
098            }
099        }
100    }