View Javadoc

1   /*
2    * Copyright 2005-2006 The Kuali Foundation
3    * 
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    * http://www.opensource.org/licenses/ecl2.php
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.kuali.ole.fp.businessobject;
18  
19  import java.util.LinkedHashMap;
20  
21  import org.kuali.ole.sys.OLEPropertyConstants;
22  import org.kuali.rice.krad.bo.DocumentHeader;
23  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
24  
25  /**
26   * This class is used to represent a distribution document.
27   */
28  public class DistributionDoc extends PersistableBusinessObjectBase {
29  
30      private String documentNumber;
31      private Integer finDocumentNextFromLineNbr;
32      private Integer finDocumentNextToLineNumber;
33      private Integer financialDocumentPostingYear;
34      private String finDocumentPostingPeriodCode;
35  
36      private DocumentHeader financialDocument;
37  
38      /**
39       * Default no-arg constructor.
40       */
41      public DistributionDoc() {
42  
43      }
44  
45      /**
46       * Gets the documentNumber attribute.
47       * 
48       * @return Returns the documentNumber
49       */
50      public String getDocumentNumber() {
51          return documentNumber;
52      }
53  
54  
55      /**
56       * Sets the documentNumber attribute.
57       * 
58       * @param documentNumber The documentNumber to set.
59       */
60      public void setDocumentNumber(String documentNumber) {
61          this.documentNumber = documentNumber;
62      }
63  
64      /**
65       * Gets the finDocumentNextFromLineNbr attribute.
66       * 
67       * @return Returns the finDocumentNextFromLineNbr
68       */
69      public Integer getFinDocumentNextFromLineNbr() {
70          return finDocumentNextFromLineNbr;
71      }
72  
73  
74      /**
75       * Sets the finDocumentNextFromLineNbr attribute.
76       * 
77       * @param finDocumentNextFromLineNbr The finDocumentNextFromLineNbr to set.
78       */
79      public void setFinDocumentNextFromLineNbr(Integer finDocumentNextFromLineNbr) {
80          this.finDocumentNextFromLineNbr = finDocumentNextFromLineNbr;
81      }
82  
83      /**
84       * Gets the finDocumentNextToLineNumber attribute.
85       * 
86       * @return Returns the finDocumentNextToLineNumber
87       */
88      public Integer getFinDocumentNextToLineNumber() {
89          return finDocumentNextToLineNumber;
90      }
91  
92  
93      /**
94       * Sets the finDocumentNextToLineNumber attribute.
95       * 
96       * @param finDocumentNextToLineNumber The finDocumentNextToLineNumber to set.
97       */
98      public void setFinDocumentNextToLineNumber(Integer finDocumentNextToLineNumber) {
99          this.finDocumentNextToLineNumber = finDocumentNextToLineNumber;
100     }
101 
102     /**
103      * Gets the financialDocumentPostingYear attribute.
104      * 
105      * @return Returns the financialDocumentPostingYear
106      */
107     public Integer getFinancialDocumentPostingYear() {
108         return financialDocumentPostingYear;
109     }
110 
111 
112     /**
113      * Sets the financialDocumentPostingYear attribute.
114      * 
115      * @param financialDocumentPostingYear The financialDocumentPostingYear to set.
116      */
117     public void setFinancialDocumentPostingYear(Integer financialDocumentPostingYear) {
118         this.financialDocumentPostingYear = financialDocumentPostingYear;
119     }
120 
121     /**
122      * Gets the finDocumentPostingPeriodCode attribute.
123      * 
124      * @return Returns the finDocumentPostingPeriodCode
125      */
126     public String getFinDocumentPostingPeriodCode() {
127         return finDocumentPostingPeriodCode;
128     }
129 
130 
131     /**
132      * Sets the finDocumentPostingPeriodCode attribute.
133      * 
134      * @param finDocumentPostingPeriodCode The finDocumentPostingPeriodCode to set.
135      */
136     public void setFinDocumentPostingPeriodCode(String finDocumentPostingPeriodCode) {
137         this.finDocumentPostingPeriodCode = finDocumentPostingPeriodCode;
138     }
139 
140     /**
141      * Gets the financialDocument attribute.
142      * 
143      * @return Returns the financialDocument
144      */
145     public DocumentHeader getFinancialDocument() {
146         return financialDocument;
147     }
148 
149 
150     /**
151      * Sets the financialDocument attribute.
152      * 
153      * @param financialDocument The financialDocument to set.
154      * @deprecated
155      */
156     public void setFinancialDocument(DocumentHeader financialDocument) {
157         this.financialDocument = financialDocument;
158     }
159 
160     /**
161      * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
162      */
163     protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
164         LinkedHashMap m = new LinkedHashMap();
165         m.put(OLEPropertyConstants.DOCUMENT_NUMBER, this.documentNumber);
166         return m;
167     }
168 }