001/*
002 * The Kuali Financial System, a comprehensive financial management system for higher education.
003 * 
004 * Copyright 2005-2014 The Kuali Foundation
005 * 
006 * This program is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU Affero General Public License as
008 * published by the Free Software Foundation, either version 3 of the
009 * License, or (at your option) any later version.
010 * 
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU Affero General Public License for more details.
015 * 
016 * You should have received a copy of the GNU Affero General Public License
017 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
018 */
019package org.kuali.kfs.pdp;
020
021
022
023/**
024 * Contains general PDP constants.
025 */
026public class PdpConstants {
027    public static final String PDP_FILE_UPLOAD_FILE_PREFIX = "pdp_payment_file";
028    public static final String PAYMENT_FILE_TYPE_INDENTIFIER = "paymentInputFileType";
029    public static final String PAYMENT_LOAD_CREATE_DATE_SEPARATOR = "T";
030    public static final String PAYMENT_LOAD_CREATE_DATE_FORMAT = "yyyy-MM-dd HH:mm:ss";
031    public static final String PDP_FDOC_TYPE_CODE = "PDP";
032    public static final String PDP_FDOC_ORIGIN_CODE = "01";
033    public static final String ACH_ACCOUNT_IDENTIFIER_SEQUENCE_NAME = "PDP_ACH_ACCT_GNRTD_ID_SEQ";
034    public static final String PDP_EXTRACT_JOB_NAME = "pdpExtractChecksJob";
035    public static final String ACH_TRANSACTION_TYPE_DEFAULT = "22";
036    public static final String ACH_BANK_DATA_VIEW_CODE_DEFAULT = "1";
037    public static final String ACH_BANK_INSTITUTION_CODE_DEFAULT = "1";
038    public static final String PDP_CUST_ID_SEQUENCE_NAME = "PDP_CUST_ID_SEQ";
039    public static final String SECURE_SOCKET_PROTOCOL = "SSL";
040
041    public static final int CHECK_NUMBER_PLACEHOLDER_VALUE = -1;
042
043    public static class PayeeIdTypeCodes {
044                public static String CUSTOMER = "C";
045        public static String SSN = "S";
046        public static String EMPLOYEE = "E";
047        public static String ENTITY = "T";
048        public static String FEIN = "F";
049        public static String VENDOR_ID = "V";
050        public static String OTHER = "X";
051    }
052
053    public static class DisbursementTypeCodes {
054        public static String CHECK = "CHCK";
055        public static String ACH = "ACH";
056    }
057
058    public static class PaymentChangeCodes {
059        public static final String CANCEL_DISBURSEMENT = "CD";
060        public static final String CANCEL_REISSUE_DISBURSEMENT = "CRD";
061        public static final String REISSUE_DISBURSEMENT = "RC";
062        public static final String CANCEL_BATCH_CHNG_CD = "CB";
063        public static final String HOLD_BATCH_CHNG_CD = "HB";
064        public static final String REMOVE_HOLD_BATCH_CHNG_CD = "RHB";
065        public static final String CANCEL_PAYMENT_CHNG_CD = "CP";
066        public static final String HOLD_CHNG_CD = "HP";
067        public static final String CHANGE_IMMEDIATE_CHNG_CD = "IMP";
068        public static final String REMOVE_HOLD_CHNG_CD = "RHP";
069        public static final String BANK_CHNG_CD = "BC";
070    }
071
072    public static class PaymentStatusCodes {
073        public static String FORMAT = "FORM";
074        public static String OPEN = "OPEN";
075        public static String CANCEL_DISBURSEMENT = "CDIS";
076        public static String CANCEL_PAYMENT = "CPAY";
077        public static String EXTRACTED = "EXTR";
078        public static String PENDING_ACH = "PACH";
079        public static String PENDING_CHECK = "PCHK";
080        public static final String HELD_TAX_ALL = "HTXA";
081        public static final String HELD_TAX_ALL_FOR_SEARCH = "HTX*";
082        public static final String HELD_CD = "HELD";
083        public static final String HELD_TAX_EMPLOYEE_CD = "HTXE";
084        public static final String HELD_TAX_NRA_CD = "HTXN";
085        public static final String HELD_TAX_NRA_EMPL_CD = "HTXB";
086    }
087    
088    public static class Actions{
089        public static final String BATCH_SEARCH_DETAIL_ACTION = "batchDetail.do";
090        public static final String PAYMENT_DETAIL_ACTION = "pdp/paymentdetail.do";
091        public static final String FORMAT_PROCESS_ACTION = "pdp/format.do";
092    }
093    
094    public static class ActionMethods{
095        public static final String CONFIRM_CANCEL_ACTION = "confirmAndCancel";
096        public static final String CONFIRM_REMOVE_HOLD_ACTION = "confirmAndRemoveHold";
097        public static final String CONFIRM_HOLD_ACTION = "confirmAndHold";
098        public static final String CONFIRM_REMOVE_IMMEDIATE_PRINT_ACTION = "confirmAndRemoveImmediate";
099        public static final String CONFIRM_SET_IMMEDIATE_PRINT_ACTION = "confirmAndSetImmediate";
100        public static final String CONFIRM_DISBURSEMENT_CANCEL_ACTION = "confirmAndCancelDisbursement";
101        public static final String CONFIRM_REISSUE_ACTION = "confirmAndReIssue";
102        public static final String CONFIRM_REISSUE_CANCEL_ACTION = "confirmAndReIssueCancel";
103        public static final String CLEAR_FORMAT_PROCESS_ACTION = "clearUnfinishedFormat";
104    }
105    
106    public static class AccountChangeCodes {
107        public static final String INVALID_ACCOUNT = "ACCT";
108        public static final String INVALID_SUB_ACCOUNT = "SA";
109        public static final String INVALID_OBJECT = "OBJ";
110        public static final String INVALID_SUB_OBJECT = "SO";
111        public static final String INVALID_PROJECT = "PROJ";
112    }
113    
114    public static class PaymentTypes {
115        public static final String ALL = "all";
116        public static final String DISBURSEMENTS_WITH_ATTACHMENTS = "pymtAttachment";
117        public static final String DISBURSEMENTS_NO_ATTACHMENTS = "pymtAttachmentFalse";
118        public static final String DISBURSEMENTS_WITH_SPECIAL_HANDLING = "pymtSpecialHandling";
119        public static final String DISBURSEMENTS_NO_SPECIAL_HANDLING = "pymtSpecialHandlingFalse";
120        public static final String PROCESS_IMMEDIATE = "immediate";
121    }
122    
123    public static final String MAPPING_SELECTION = "selection";
124    public static final String MAPPING_CONTINUE = "continue";
125    public static final String MAPPING_RUNNING = "running";
126    public static final String MAPPING_FINISHED = "finished";
127    
128    public static class PDPEditMode {
129        public static final String ENTRY = "entry";
130    }
131    
132    public static class AchBankOfficeCodes {
133        public static final String AchBankOfficeCode_O = "O";
134        public static final String AchBankOfficeCode_B = "B";
135    }
136    
137    public static class AchBankTypeCodes {
138        public static final String AchBankTypeCode_0 = "0";
139        public static final String AchBankTypeCode_1 = "1";
140        public static final String AchBankTypeCode_2 = "2";
141    }
142    
143    public static class PermissionNames{
144        public static final String CANCEL_PAYMENT = "Cancel Payment";
145        public static final String FORMAT = "Format";
146        public static final String HOLD_PAYMENT_REMOVE_NON_TAX_PAYMENT_HOLD = "Hold Payment / Remove Non-Tax Payment Hold";
147        public static final String REMOVE_FORMAT_LOCK = "Remove Format Lock";
148        public static final String REMOVE_PAYMENT_TAX_HOLD = "Remove Payment Tax Hold";
149        public static final String SET_AS_IMMEDIATE_PAY = "Set as Immmediate Pay";
150    }
151    
152    public static class MethodToCallNames {
153        public static final String START = "start";
154
155    }
156
157    // Changes for the Research Participant Upload
158    public static final String RESEARCH_PARTICIPANT_INPUT_FILE_TYPE_INDENTIFIER = "researchParticipantInputFileType";
159    public static final String RESEARCH_PARTICIPANT_CUSTOMER_PROFILE = "RESEARCH_PARTICIPANT_UPLOAD_CUSTOMER_PROFILE";
160    public static final String RESEARCH_PARTICIPANT_FILE_PREFIX = "RP-Upload";
161    public static final String MULTIPLE_ACCOUNTS = "There are more than one accounting lines.";
162    public static final String MULTIPLE_PAYMENT_HEADERS = "There are more than one payment headers.";
163    public static final String FILE_NAME_PART_DELIMITER = "_";
164
165    public static class SequenceNames {
166        public static final String PDP_PMT_FIL_ID = "PDP_PMT_FIL_ID_SEQ";
167    }
168
169    public static class PaymentHeader {
170        public static final String CHART = "chartOfAccountsCode";
171        public static final String UNIT = "unit";
172        public static final String SUBUNIT = "subUnit";
173        public static final String CREATION_DATE = "creationDate";
174        public static final String VENDOR_OR_EMPLOYEE = "vendorOrEmployee";
175        public static final String SOURCE_DOC_NUMBER = "sourceDocNumber";
176        public static final String PAYMENT_DATE = "paymentDate";
177    }
178
179    public static class PaymentAccountDetail {
180        public static final String CHART = "finChartCode";
181        public static final String ACCOUNT_NBR = "accountNbr";
182        public static final String SUB_ACCOUNT_NBR = "subAccountNbr";
183        public static final String OBJECT_CODE = "finObjectCode";
184        public static final String SUB_OBJECT_CODE = "finSubObjectCode";
185        public static final String PROJECT_CODE = "projectCode";
186        public static final String ORG_REF_ID = "orgReferenceId";
187    }
188
189    public static class PaymentDetail {
190        public static final String PAYEE_NAME = "payeeName";
191        public static final String ADDRESS_LINE_1 = "addressLine1";
192        public static final String ADDRESS_LINE_2 = "addressLine2";
193        public static final String ADDRESS_LINE_3 = "addressLine3";
194        public static final String CITY = "city";
195        public static final String STATE = "state";
196        public static final String ZIP = "zip";
197        public static final String CHECK_STUB_TEXT = "checkStubText";
198        public static final String AMOUNT = "amount";
199    }
200
201    public static class PayeeACHAccountDocumentStrings{
202        public static final String PAYEE_NAME = "Payee Name";
203        public static final String PAYEE_EMAIL_ADDRESS = "Email Address";
204        public static final String EDIT_PAYEE_ACH_ACCOUNT ="Edit Payee ACH Account";
205    }
206}