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.pdp;
017    
018    import org.kuali.kfs.sys.KFSConstants;
019    import org.kuali.rice.kns.authorization.AuthorizationConstants.EditMode;
020    
021    /**
022     * Contains general PDP constants.
023     */
024    public class PdpConstants {
025        public static final String PDP_FILE_UPLOAD_FILE_PREFIX = "pdp_payment_file";
026        public static final String PAYMENT_FILE_TYPE_INDENTIFIER = "paymentInputFileType";
027        public static final String PAYMENT_LOAD_CREATE_DATE_SEPARATOR = "T";
028        public static final String PAYMENT_LOAD_CREATE_DATE_FORMAT = "yyyy-MM-dd HH:mm:ss";
029        public static final String PDP_FDOC_TYPE_CODE = "PDP";
030        public static final String PDP_FDOC_ORIGIN_CODE = "01";
031        public static final String ACH_ACCOUNT_IDENTIFIER_SEQUENCE_NAME = "PDP_ACH_ACCT_GNRTD_ID_SEQ";
032        public static final String PDP_EXTRACT_JOB_NAME = "pdpExtractChecksJob";
033        public static final String ACH_TRANSACTION_TYPE_DEFAULT = "22";
034        public static final String ACH_BANK_DATA_VIEW_CODE_DEFAULT = "1";
035        public static final String ACH_BANK_INSTITUTION_CODE_DEFAULT = "1";
036        public static final String PDP_CUST_ID_SEQUENCE_NAME = "PDP_CUST_ID_SEQ";
037        
038        public static final int CHECK_NUMBER_PLACEHOLDER_VALUE = -1;
039    
040        public static class PayeeIdTypeCodes {
041            public static String SSN = "S";
042            public static String EMPLOYEE = "E";
043            public static String ENTITY = "T";
044            public static String FEIN = "F";
045            public static String VENDOR_ID = "V";
046            public static String OTHER = "X";
047        }
048    
049        public static class DisbursementTypeCodes {
050            public static String CHECK = "CHCK";
051            public static String ACH = "ACH";
052        }
053    
054        public static class PaymentChangeCodes {
055            public static final String CANCEL_DISBURSEMENT = "CD";
056            public static final String CANCEL_REISSUE_DISBURSEMENT = "CRD";
057            public static final String CANCEL_BATCH_CHNG_CD = "CB";
058            public static final String HOLD_BATCH_CHNG_CD = "HB";
059            public static final String REMOVE_HOLD_BATCH_CHNG_CD = "RHB";
060            public static final String CANCEL_PAYMENT_CHNG_CD = "CP";
061            public static final String HOLD_CHNG_CD = "HP";
062            public static final String CHANGE_IMMEDIATE_CHNG_CD = "IMP";
063            public static final String REMOVE_HOLD_CHNG_CD = "RHP";
064            public static final String BANK_CHNG_CD = "BC";
065        }
066    
067        public static class PaymentStatusCodes {
068            public static String FORMAT = "FORM";
069            public static String OPEN = KFSConstants.PdpConstants.PAYMENT_OPEN_STATUS_CODE;
070            public static String CANCEL_DISBURSEMENT = "CDIS";
071            public static String CANCEL_PAYMENT = "CPAY";
072            public static String EXTRACTED = "EXTR";
073            public static String PENDING_ACH = "PACH";
074            public static String PENDING_CHECK = "PCHK";
075            public static final String HELD_TAX_ALL = "HTXA";
076            public static final String HELD_TAX_ALL_FOR_SEARCH = "HTX*";
077            public static final String HELD_CD = "HELD";
078            public static final String HELD_TAX_EMPLOYEE_CD = "HTXE";
079            public static final String HELD_TAX_NRA_CD = "HTXN";
080            public static final String HELD_TAX_NRA_EMPL_CD = "HTXB";
081        }
082        
083        public static class Actions{
084            public static final String BATCH_SEARCH_DETAIL_ACTION = "batchDetail.do";
085            public static final String PAYMENT_DETAIL_ACTION = "pdp/paymentdetail.do";
086            public static final String FORMAT_PROCESS_ACTION = "pdp/format.do";
087        }
088        
089        public static class ActionMethods{
090            public static final String CONFIRM_CANCEL_ACTION = "confirmAndCancel";
091            public static final String CONFIRM_REMOVE_HOLD_ACTION = "confirmAndRemoveHold";
092            public static final String CONFIRM_HOLD_ACTION = "confirmAndHold";
093            public static final String CONFIRM_REMOVE_IMMEDIATE_PRINT_ACTION = "confirmAndRemoveImmediate";
094            public static final String CONFIRM_SET_IMMEDIATE_PRINT_ACTION = "confirmAndSetImmediate";
095            public static final String CONFIRM_DISBURSEMENT_CANCEL_ACTION = "confirmAndCancelDisbursement";
096            public static final String CONFIRM_REISSUE_CANCEL_ACTION = "confirmAndReIssueCancel";
097            public static final String CLEAR_FORMAT_PROCESS_ACTION = "clearUnfinishedFormat";
098        }
099        
100        public static class AccountChangeCodes {
101            public static final String INVALID_ACCOUNT = "ACCT";
102            public static final String INVALID_SUB_ACCOUNT = "SA";
103            public static final String INVALID_OBJECT = "OBJ";
104            public static final String INVALID_SUB_OBJECT = "SO";
105            public static final String INVALID_PROJECT = "PROJ";
106        }
107        
108        public static class PaymentTypes {
109            public static final String ALL = "all";
110            public static final String DISBURSEMENTS_WITH_ATTACHMENTS = "pymtAttachment";
111            public static final String DISBURSEMENTS_NO_ATTACHMENTS = "pymtAttachmentFalse";
112            public static final String DISBURSEMENTS_WITH_SPECIAL_HANDLING = "pymtSpecialHandling";
113            public static final String DISBURSEMENTS_NO_SPECIAL_HANDLING = "pymtSpecialHandlingFalse";
114            public static final String PROCESS_IMMEDIATE = "immediate";
115        }
116        
117        public static final String MAPPING_SELECTION = "selection";
118        public static final String MAPPING_CONTINUE = "continue";
119        public static final String MAPPING_FINISHED = "finished";
120        
121        public static class PDPEditMode extends EditMode {
122            public static final String ENTRY = "entry";
123        }
124        
125        public static class AchBankOfficeCodes {
126            public static final String AchBankOfficeCode_O = "O";
127            public static final String AchBankOfficeCode_B = "B";
128        }
129        
130        public static class AchBankTypeCodes {
131            public static final String AchBankTypeCode_0 = "0";
132            public static final String AchBankTypeCode_1 = "1";
133            public static final String AchBankTypeCode_2 = "2";
134        }
135        
136        public static class PermissionNames{
137            public static final String CANCEL_PAYMENT = "Cancel Payment";
138            public static final String FORMAT = "Format";
139            public static final String HOLD_PAYMENT_REMOVE_NON_TAX_PAYMENT_HOLD = "Hold Payment / Remove Non-Tax Payment Hold";
140            public static final String REMOVE_FORMAT_LOCK = "Remove Format Lock";
141            public static final String REMOVE_PAYMENT_TAX_HOLD = "Remove Payment Tax Hold";
142            public static final String SET_AS_IMMEDIATE_PAY = "Set as Immmediate Pay";
143        }
144        
145        public static class MethodToCallNames {
146            public static final String START = "start";
147            
148        }
149    }