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.module.endow.businessobject;
017
018 import java.util.LinkedHashMap;
019
020 import org.kuali.rice.kns.bo.TransientBusinessObjectBase;
021 import org.kuali.rice.kns.util.KualiDecimal;
022
023 public abstract class TransactionDocumentForReportLineBase extends TransientBusinessObjectBase {
024 protected String documentType;
025 protected String documentId;
026 protected String securityId;
027 protected KualiDecimal incomeAmount = KualiDecimal.ZERO;
028 protected KualiDecimal incomeUnits = KualiDecimal.ZERO;
029 protected KualiDecimal principalAmount = KualiDecimal.ZERO;
030 protected KualiDecimal principalUnits = KualiDecimal.ZERO;
031
032 /**
033 * Gets the documentType attribute.
034 * @return Returns the documentType.
035 */
036 public String getDocumentType() {
037 return documentType;
038 }
039
040 /**
041 * Sets the documentType attribute value.
042 * @param documentType The documentType to set.
043 */
044 public void setDocumentType(String documentType) {
045 this.documentType = documentType;
046 }
047
048 /**
049 * Gets the documentId attribute.
050 * @return Returns the documentId.
051 */
052 public String getDocumentId() {
053 return documentId;
054 }
055
056 /**
057 * Sets the documentId attribute value.
058 * @param documentId The documentId to set.
059 */
060 public void setDocumentId(String documentId) {
061 this.documentId = documentId;
062 }
063
064 /**
065 * Gets the securityId attribute.
066 * @return Returns the securityId.
067 */
068 public String getSecurityId() {
069 return securityId;
070 }
071
072
073 /**
074 * Sets the securityId attribute.
075 * @param the securityId.
076 */
077 public void setSecurityId(String securityId) {
078 this.securityId = securityId;
079 }
080
081 /**
082 * Gets the incomeAmount attribute.
083 * @return Returns the incomeAmount.
084 */
085 public KualiDecimal getIncomeAmount() {
086 return incomeAmount;
087 }
088
089 /**
090 * Sets the incomeAmount attribute.
091 * @param the incomeAmount.
092 */
093 public void setIncomeAmount(KualiDecimal incomeAmount) {
094 this.incomeAmount = incomeAmount;
095 }
096
097 /**
098 * Gets the incomeUnits attribute.
099 * @return Returns the incomeUnits.
100 */
101 public KualiDecimal getIncomeUnits() {
102 return incomeUnits;
103 }
104
105 /**
106 * Sets the incomeUnits attribute.
107 * @param the incomeUnits.
108 */
109 public void setIncomeUnits(KualiDecimal incomeUnits) {
110 this.incomeUnits = incomeUnits;
111 }
112
113 /**
114 * Gets the principalAmount attribute.
115 * @return Returns the principalAmount.
116 */
117 public KualiDecimal getPrincipalAmount() {
118 return principalAmount;
119 }
120
121 /**
122 * Sets the principalAmount attribute.
123 * @param the principalAmount.
124 */
125 public void setPrincipalAmount(KualiDecimal principalAmount) {
126 this.principalAmount = principalAmount;
127 }
128
129 /**
130 * Gets the principalUnits attribute.
131 * @return Returns the principalUnits.
132 */
133 public KualiDecimal getPrincipalUnits() {
134 return principalUnits;
135 }
136
137 /**
138 * Sets the principalUnits attribute.
139 * @param the principalUnits.
140 */
141 public void setPrincipalUnits(KualiDecimal principalUnits) {
142 this.principalUnits = principalUnits;
143 }
144
145 /**
146 * Adds a income amount to the current income total
147 * @param incomeAmount the income amount to add to the income total
148 */
149 public void addIncomeAmount(KualiDecimal incomeAmount) {
150 this.incomeAmount = this.incomeAmount.add(incomeAmount);
151
152 }
153
154 /**
155 * Adds a principal amount to the current principal total
156 * @param principalAmount the principal amount to add to the principal total
157 */
158 public void addPrincipalAmount(KualiDecimal principalAmount) {
159 this.principalAmount = this.principalAmount.add(principalAmount);
160 }
161
162
163 /**
164 * Adds a income units to the current income units total
165 * @param incomeUnits the income units to add to the income units total
166 */
167 public void addIncomeUnits(KualiDecimal incomeUnits) {
168 this.incomeUnits = this.incomeUnits.add(incomeUnits);
169 }
170
171 /**
172 * Adds a principal units to the current principal units total
173 * @param principalUnits the principal units to add to the principal units total
174 */
175 public void addPrincipalUnits(KualiDecimal principalUnits) {
176 this.principalUnits = this.principalUnits.add(principalUnits);
177 }
178
179 /**
180 * @see org.kuali.rice.kns.bo.BusinessObjectBase#toStringMapper()
181 */
182 @Override
183 protected LinkedHashMap toStringMapper() {
184 return new LinkedHashMap();
185 }
186
187 }