DocVO


1   /******************************************************************************
2    * The contents of this file are subject to the   Compiere License  Version 1.1
3    * ("License"); You may not use this file except in compliance with the License
4    * You may obtain a copy of the License at http://www.compiere.org/license.html
5    * Software distributed under the License is distributed on an  "AS IS"  basis,
6    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
7    * the specific language governing rights and limitations under the License.
8    * The Original Code is                  Compiere  ERP & CRM  Business Solution
9    * The Initial Developer of the Original Code is Jorg Janke  and ComPiere, Inc.
10   * Portions created by Jorg Janke are Copyright (C) 1999-2001 Jorg Janke, parts
11   * created by ComPiere are Copyright (C) ComPiere, Inc.;   All Rights Reserved.
12   * Contributor(s): ______________________________________.
13   *****************************************************************************/
14  package org.compiere.acct;
15  
16  import java.sql.*;
17  import java.math.*;
18  
19  import org.compiere.util.Env;
20  
21  /**
22   *  Document Value Object - holds common Document Information
23   *
24   *  @author Jorg Janke
25   *  @version  $Id: DocVO.java,v 1.15 2003/07/22 06:28:03 jjanke Exp $
26   */
27  public class DocVO
28  {
29      /**
30       *  Constructor
31       *  @param ad_Table_ID AD_Table_ID
32       */
33      protected DocVO (int ad_Table_ID)
34      {
35          AD_Table_ID = ad_Table_ID;
36          //  Amounts
37          Amounts[0] = Env.ZERO;
38          Amounts[1] = Env.ZERO;
39          Amounts[2] = Env.ZERO;
40          Amounts[3] = Env.ZERO;
41      }   //  DocVO
42  
43      //  --- ID
44  
45      /** ID - Document Type      */
46      public String             DocumentType;
47      /** ID - Table ID           */
48      public int              AD_Table_ID;
49      /** ID - Record ID          */
50      public int              Record_ID;
51  
52      //  --- Mandatory
53  
54      /** Client                  */
55      public int              AD_Client_ID = 0;
56      /** Otganization            */
57      public int              AD_Org_ID = 0;
58  
59      //  --- Optional
60  
61      /** Dimensions              */
62      public int              C_BPartner_ID = 0;
63      public int              M_Product_ID = 0;
64      public int              AD_OrgTrx_ID = 0;
65      public int              C_SalesRegion_ID = 0;
66      public int              C_Project_ID = 0;
67      public int              C_Campaign_ID = 0;
68      public int              C_Activity_ID = 0;
69      public int              C_LocFrom_ID = 0;
70      public int              C_LocTo_ID = 0;
71      public int              User1_ID = 0;
72      public int              User2_ID = 0;
73  
74      //  Reference (to find SalesRegion from BPartner)
75      public int              C_BPartner_Location_ID = 0;
76      public int              BP_C_SalesRegion_ID = -1;   //  set in FactLine
77  
78      //  --- Attributes
79  
80      public String             DocumentNo = null;
81      public Timestamp        DateAcct = null;
82      public Timestamp        DateDoc = null;
83  
84      public static final int PERIOD_UNDEFINED = -29;
85      public int              C_Period_ID = PERIOD_UNDEFINED;
86  
87      public boolean          TaxIncluded = false;
88  
89      /** Is (Source) Multi-Currency Document - i.e. the document has different currencies
90       *  (if true, the document will not be source balanced)     */
91      public boolean          MultiCurrency = false;
92  
93      //  --  Reference
94  
95      public int              GL_Category_ID = 0;
96      public int              GL_Budget_ID = 0;
97  
98      public int              C_BankAccount_ID = 0;
99      public int              C_CashBook_ID = 0;
100 
101     public int              C_Charge_ID = 0;
102     public BigDecimal       ChargeAmt = null;
103 
104     public int              M_Warehouse_ID = 0;
105 
106     public boolean          Posted = false;
107 
108     /*************************************************************************/
109 
110     /** Source Currency         */
111     public int              C_Currency_ID = 0;
112     /** Source Amounts          */
113     public BigDecimal[]     Amounts = new BigDecimal[4];
114 
115     public BigDecimal       Qty = null;
116 
117     /*************************************************************************/
118 
119     /** Actual Document Status  */
120     public String             Status = null;
121 
122     public String             Error = null;
123 
124     //  Posting Status - AD_Reference_ID=234     //
125     /** Document Status         */
126     public static final String    STATUS_NotPosted        = "N";
127     /** Document Status         */
128     public static final String    STATUS_NotBalanced      = "b";
129     /** Document Status         */
130     public static final String    STATUS_NotConvertible   = "c";
131     /** Document Status         */
132     public static final String    STATUS_PeriodClosed     = "p";
133     /** Document Status         */
134     public static final String    STATUS_InvalidAccount   = "i";
135     /** Document Status         */
136     public static final String    STATUS_PostPrepared     = "y";
137     /** Document Status         */
138     public static final String    STATUS_Posted           = "Y";
139     /** Document Status         */
140     public static final String    STATUS_Error            = "E";
141 
142     /**************************************************************************
143      *   Document Types
144      *  --------------
145      *  C_DocType.DocBaseType & AD_Reference_ID=183
146      *
147      *  C_Invoice:          ARI, ARC, ARF, API, APC
148      *  C_Payment:          ARP, APP
149      *  C_Order:            SOO, POO
150      *  M_Transaction:      MMI, MMM, MMS, MMR
151      *  C_BankStatement:    CMB
152      *  C_Cash:             CMC
153      *  C_Allocation:       CMA
154      *  GL_Journal:         GLJ
155      *
156      *  ???
157      *  requisition         POR
158      */
159 
160     /** Document Type for Document/GL Info      */
161     public int                  C_DocType_ID = 0;
162 
163     /** AR Invoices             */
164     public static final String    DOCTYPE_ARInvoice       = "ARI";
165     /** AR Credit Memo          */
166     public static final String    DOCTYPE_ARCredit        = "ARC";
167     /** AR Receipt              */
168     public static final String    DOCTYPE_ARReceipt       = "ARR";
169     /** AR ProForma             */
170     public static final String    DOCTYPE_ARProForma      = "ARF";
171 
172     /** AP Invoices             */
173     public static final String    DOCTYPE_APInvoice       = "API";
174     /** AP Credit Memo          */
175     public static final String    DOCTYPE_APCredit        = "APC";
176     /** AP Payment              */
177     public static final String    DOCTYPE_APPayment       = "APP";
178 
179     /** CashManagement Bank Statement   */
180     public static final String    DOCTYPE_BankStatement   = "CMB";
181     /** CashManagement Cash Journals    */
182     public static final String    DOCTYPE_CashJournal     = "CMC";
183     /** CashManagement Allocations      */
184     public static final String    DOCTYPE_Allocation      = "CMA";
185 
186     /** Material Shipment       */
187     public static final String    DOCTYPE_MatShipment     = "MMS";
188     /** Material Receipt        */
189     public static final String    DOCTYPE_MatReceipt      = "MMR";
190     /** Material Inventory      */
191     public static final String    DOCTYPE_MatInventory    = "MMI";
192     /** Material Movement       */
193     public static final String    DOCTYPE_MatMovement     = "MMM";
194     /** Material Production     */
195     public static final String    DOCTYPE_MatProduction   = "MMP";
196 
197     /** Match Invoice           */
198     public static final String    DOCTYPE_MatMatchInv     = "MXI";
199     /** Match PO                */
200     public static final String    DOCTYPE_MatMatchPO      = "MXP";
201 
202     /** GL Journal              */
203     public static final String    DOCTYPE_GLJournal       = "GLJ";
204 
205     /** Purchase Order          */
206     public static final String    DOCTYPE_POrder          = "POO";
207     /** Sales Order             */
208     public static final String    DOCTYPE_SOrder          = "SOO";
209 
210 
211 
212     /*************************************************************************/
213 
214     /**
215      * String representation
216      * @return String
217      */
218     public String   toString()
219     {
220         StringBuffer   sb = new StringBuffer  ("Doc=[");
221         sb.append(DocumentType)
222             .append(" - DocumentNo=").append(DocumentNo)
223             .append(",DateAcct=").append(DateAcct.toString().substring(0,10))
224             .append(",Sta=").append(Status);
225         sb.append("]");
226         return sb.toString();
227     }   //  toString
228 
229 }   //  DocVO
230
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags