CommonConstants.java

/*
 jBilling - The Enterprise Open Source Billing System
 Copyright (C) 2003-2011 Enterprise jBilling Software Ltd. and Emiliano Conde

 This file is part of jbilling.

 jbilling is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 jbilling is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with jbilling.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.sapienter.jbilling.common;

import java.math.BigDecimal;

/**
 * @author Emil
 */
public interface CommonConstants {
    public static final String LIST_TYPE_ITEM_TYPE = "type";
    public static final String LIST_TYPE_CUSTOMER = "customer";
    public static final String LIST_TYPE_CUSTOMER_SIMPLE = "customerSimple";
    public static final String LIST_TYPE_PARTNERS_CUSTOMER = "partnersCustomer";
    public static final String LIST_TYPE_SUB_ACCOUNTS = "sub_accounts";
    public static final String LIST_TYPE_ITEM = "item";
    public static final String LIST_TYPE_ITEM_ORDER = "itemOrder";
    public static final String LIST_TYPE_ITEM_USER_PRICE = "price";
    public static final String LIST_TYPE_PROMOTION = "promotion";
    public static final String LIST_TYPE_PAYMENT = "payment";
    public static final String LIST_TYPE_PAYMENT_USER = "paymentUser";
    public static final String LIST_TYPE_ORDER = "order";
    public static final String LIST_TYPE_INVOICE = "invoice";
    public static final String LIST_TYPE_REFUND = "refund";
    public static final String LIST_TYPE_INVOICE_GRAL = "invoiceGeneral";
    public static final String LIST_TYPE_PROCESS = "process";
    public static final String LIST_TYPE_PROCESS_INVOICES = "processInvoices";
    public static final String LIST_TYPE_PROCESS_RUN_SUCCESSFULL_USERS = "processRunSuccessfullUsers";
    public static final String LIST_TYPE_PROCESS_RUN_FAILED_USERS = "processRunFailedUsers";    
    public static final String LIST_TYPE_PROCESS_ORDERS= "processOrders";
    public static final String LIST_TYPE_NOTIFICATION_TYPE= "notificationType";
    public static final String LIST_TYPE_PARTNER = "partner";
    public static final String LIST_TYPE_PAYOUT = "payout";
    public static final String LIST_TYPE_INVOICE_ORDER = "invoicesOrder";
    
    // results from payments
    // this has to by in synch with how the database is initialized
    public static final Integer RESULT_OK = new Integer(1);
    public static final Integer RESULT_FAIL = new Integer(2);
    public static final Integer RESULT_UNAVAILABLE = new Integer(3);   
    public static final Integer RESULT_ENTERED = new Integer(4);
    // a special one, to represent 'no result' (for filers, routers, etc)
    public static final Integer RESULT_NULL = new Integer(0);

    // user types, these have to by in synch with the user_type table
    // these are needed in the server side and the jsps
    public static final Integer TYPE_INTERNAL = new Integer(1);
    public static final Integer TYPE_ROOT = new Integer(2);
    public static final Integer TYPE_CLERK = new Integer(3);
    public static final Integer TYPE_PARTNER = new Integer(4);
    public static final Integer TYPE_CUSTOMER = new Integer(5);

    // payment methods (db - synch)
    public static final Integer PAYMENT_METHOD_CHEQUE = new Integer(1);
    public static final Integer PAYMENT_METHOD_VISA = new Integer(2);
    public static final Integer PAYMENT_METHOD_MASTERCARD = new Integer(3);
    public static final Integer PAYMENT_METHOD_AMEX = new Integer(4);
    public static final Integer PAYMENT_METHOD_ACH = new Integer(5);
    public static final Integer PAYMENT_METHOD_DISCOVERY = new Integer(6);
    public static final Integer PAYMENT_METHOD_DINERS = new Integer(7);
    public static final Integer PAYMENT_METHOD_PAYPAL = new Integer(8);
    public static final Integer PAYMENT_METHOD_GATEWAY_KEY = new Integer(9);
    
    //payment result 
    public static final Integer PAYMENT_RESULT_SUCCESSFUL = new Integer(1);
    public static final Integer PAYMENT_RESULT_FAILED = new Integer(2);
    public static final Integer PAYMENT_RESULT_PROCESSOR_UNAVAILABLE = new Integer(3);
    public static final Integer PAYMENT_RESULT_ENTERED = new Integer(4);
 
    // billing process review status
    public static final Integer REVIEW_STATUS_GENERATED = new Integer(1);
    public static final Integer REVIEW_STATUS_APPROVED = new Integer(2);
    public static final Integer REVIEW_STATUS_DISAPPROVED = new Integer(3);
    
    // these are the preference's types. This has to be in synch with the DB
    //public static Integer PREFERENCE_PAYMENT_WITH_PROCESS = new Integer(1); obsolete
    public static Integer PREFERENCE_CSS_LOCATION = new Integer(2);
    public static Integer PREFERENCE_LOGO_LOCATION = new Integer(3);
    public static Integer PREFERENCE_GRACE_PERIOD = new Integer(4);
    public static Integer PREFERENCE_PART_DEF_RATE = new Integer(5);
    public static Integer PREFERENCE_PART_DEF_FEE = new Integer(6);
    public static Integer PREFERENCE_PART_DEF_ONE_TIME = new Integer(7);
    public static Integer PREFERENCE_PART_DEF_PER_UNIT = new Integer(8);
    public static Integer PREFERENCE_PART_DEF_PER_VALUE = new Integer(9);
    public static Integer PREFERENCE_PART_DEF_AUTOMATIC = new Integer(10);
    public static Integer PREFERENCE_PART_DEF_CLERK = new Integer(11);
    public static Integer PREFERENCE_PART_DEF_FEE_CURR = new Integer(12);
    public static Integer PREFERENCE_PAPER_SELF_DELIVERY = new Integer(13);
    public static Integer PREFERENCE_SHOW_NOTE_IN_INVOICE = new Integer(14);
    public static Integer PREFERENCE_DAYS_ORDER_NOTIFICATION_S1 = new Integer(15);
    public static Integer PREFERENCE_DAYS_ORDER_NOTIFICATION_S2 = new Integer(16);
    public static Integer PREFERENCE_DAYS_ORDER_NOTIFICATION_S3 = new Integer(17);
    public static Integer PREFERENCE_INVOICE_PREFIX = new Integer(18);
    public static Integer PREFERENCE_INVOICE_NUMBER = new Integer(19);
    public static Integer PREFERENCE_INVOICE_DELETE = new Integer(20);
    public static Integer PREFERENCE_USE_INVOICE_REMINDERS = new Integer(21);
    public static Integer PREFERENCE_FIRST_REMINDER = new Integer(22);
    public static Integer PREFERENCE_NEXT_REMINDER = new Integer(23);
    public static Integer PREFERENCE_USE_DF_FM = new Integer(24);
    public static Integer PREFERENCE_USE_OVERDUE_PENALTY = new Integer(25);
    public static Integer PREFERENCE_PAGE_SIZE = new Integer(26);
    public static Integer PREFERENCE_USE_ORDER_ANTICIPATION = new Integer(27);
    public static Integer PREFERENCE_PAYPAL_ACCOUNT = new Integer(28);
    public static Integer PREFERENCE_PAYPAL_BUTTON_URL = new Integer(29);
    public static Integer PREFERENCE_URL_CALLBACK = new Integer(30);
    public static Integer PREFERENCE_CONTINUOUS_DATE = new Integer(31);
    public static Integer PREFERENCE_PDF_ATTACHMENT= new Integer(32);
    public static Integer PREFERENCE_ORDER_OWN_INVOICE = new Integer(33);
    public static Integer PREFERENCE_PRE_AUTHORIZE_CC = new Integer(34);
    public static Integer PREFERENCE_ORDER_IN_INVOICE_LINE = new Integer(35);
    public static Integer PREFERENCE_CUSTOMER_CONTACT_EDIT = new Integer(36);
    public static Integer PREFERENCE_HIDE_CC_NUMBERS = new Integer(37);
    public static Integer PREFERENCE_LINK_AGEING_TO_SUBSCRIPTION = new Integer(38);
    public static Integer PREFERENCE_FAILED_LOGINS_LOCKOUT = new Integer(39);
    public static Integer PREFERENCE_PASSWORD_EXPIRATION = new Integer(40);
    public static Integer PREFERENCE_USE_CURRENT_ORDER = new Integer(41);
    public static Integer PREFERENCE_USE_PRO_RATING = new Integer(42);
    public static Integer PREFERENCE_USE_BLACKLIST = new Integer(43);
    public static Integer PREFERENCE_ALLOW_NEGATIVE_PAYMENTS = new Integer(44);
    public static Integer PREFERENCE_DELAY_NEGATIVE_PAYMENTS = new Integer(45);
    public static Integer PREFERENCE_ALLOW_INVOICES_WITHOUT_ORDERS = new Integer(46);
    public static Integer PREFERENCE_MEDIATION_JDBC_READER_LAST_ID = new Integer(47);
    public static Integer PREFERENCE_USE_PROVISIONING = new Integer(48);
    public static Integer PREFERENCE_AUTO_RECHARGE_THRESHOLD = new Integer(49);

    // order status, in synch with db
    public static final Integer ORDER_STATUS_ACTIVE = new Integer(1);
    public static final Integer ORDER_STATUS_FINISHED = new Integer(2);
    public static final Integer ORDER_STATUS_SUSPENDED = new Integer(3);
    public static final Integer ORDER_STATUS_SUSPENDED_AGEING = new Integer(4);

    // invoice status, in synch with db
    public static final Integer INVOICE_STATUS_PAID = new Integer(1);
    public static final Integer INVOICE_STATUS_UNPAID = new Integer(2);
    public static final Integer INVOICE_STATUS_UNPAID_AND_CARRIED = new Integer(3);

    // process run status, in synch with db
    public static final Integer PROCESS_RUN_STATUS_RINNING = new Integer(1);
    public static final Integer PROCESS_RUN_STATUS_SUCCESS = new Integer(2);
    public static final Integer PROCESS_RUN_STATUS_FAILED = new Integer(3);
    
    // invoice delivery method types
    public static final Integer D_METHOD_EMAIL = new Integer(1);
    public static final Integer D_METHOD_PAPER = new Integer(2);
    public static final Integer D_METHOD_EMAIL_AND_PAPER = new Integer(3);
    
    // automatic payment methods
    // how a customer wants to pay in the automatic process
    public static final Integer AUTO_PAYMENT_TYPE_CC = new Integer(1);
    public static final Integer AUTO_PAYMENT_TYPE_ACH =  new Integer(2);
    public static final Integer AUTO_PAYMENT_TYPE_CHEQUE = new Integer(3);
    
    // types of PDF batch generation
    public static final Integer OPERATION_TYPE_CUSTOMER = new Integer(1);
    public static final Integer OPERATION_TYPE_RANGE = new Integer(2);
    public static final Integer OPERATION_TYPE_PROCESS = new Integer(3);
    public static final Integer OPERATION_TYPE_DATE = new Integer(4);
    public static final Integer OPERATION_TYPE_NUMBER = new Integer(5);
    
    /**
     * BigDecimal caculation constants <br/>
     * This value must be inline with underlying SQL data type
     */
    public static final int BIGDECIMAL_SCALE = 10;
    /**
     * Round to 2 decimals for view. Use it with formatters and/or toString
     */
    public static final int BIGDECIMAL_SCALE_STR = 2;
    public static final int BIGDECIMAL_ROUND = BigDecimal.ROUND_HALF_UP;

    public static final BigDecimal BIGDECIMAL_ONE = new BigDecimal("1");
    public static final BigDecimal BIGDECIMAL_ONE_CENT = new BigDecimal("0.01");

    // codes for login resuls
    public final static Integer AUTH_OK = new Integer(0);
    public final static Integer AUTH_WRONG_CREDENTIALS = new Integer(1);
    public final static Integer AUTH_LOCKED = new Integer(2);  // invalid login creds - bad attempt locked account
    public final static Integer AUTH_EXPIRED = new Integer(3); // login creds ok - password expired and needs updating

    // provisioning status constants
    public final static Integer PROVISIONING_STATUS_ACTIVE=new Integer(1);
    public final static Integer PROVISIONING_STATUS_INACTIVE=new Integer(2);
    public final static Integer PROVISIONING_STATUS_PENDING_ACTIVE=new Integer(3);
    public final static Integer PROVISIONING_STATUS_PENDING_INACTIVE=new Integer(4);
    public final static Integer PROVISIONING_STATUS_FAILED=new Integer(5);
    public final static Integer PROVISIONING_STATUS_UNAVAILABLE = new Integer(6);

    // types of balances
    public final static Integer BALANCE_NO_DYNAMIC = new Integer(1); // the default
    public final static Integer BALANCE_PRE_PAID = new Integer(2);
    public final static Integer BALANCE_CREDIT_LIMIT = new Integer(3);

    // mediation record status
    public final static Integer MEDIATION_RECORD_STATUS_DONE_AND_BILLABLE = new Integer(1);
    public final static Integer MEDIATION_RECORD_STATUS_DONE_AND_NOT_BILLABLE = new Integer(2);
    public final static Integer MEDIATION_RECORD_STATUS_ERROR_DETECTED = new Integer(3);
    public final static Integer MEDIATION_RECORD_STATUS_ERROR_DECLARED = new Integer(4);
}