View Javadoc

1   /**
2    * Copyright 2010 The Kuali Foundation Licensed under the
3    * Educational Community License, Version 2.0 (the "License"); you may
4    * not use this file except in compliance with the License. You may
5    * obtain a copy of the License at
6    *
7    * http://www.osedu.org/licenses/ECL-2.0
8    *
9    * Unless required by applicable law or agreed to in writing,
10   * software distributed under the License is distributed on an "AS IS"
11   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12   * or implied. See the License for the specific language governing
13   * permissions and limitations under the License.
14   */
15  
16  package org.kuali.student.common.dto;
17  
18  import java.io.Serializable;
19  
20  import javax.xml.bind.annotation.XmlAccessType;
21  import javax.xml.bind.annotation.XmlAccessorType;
22  import javax.xml.bind.annotation.XmlAttribute;
23  import javax.xml.bind.annotation.XmlElement;
24  
25  /**
26   * Detailed information about an amount of currency including both the type of units and the quantity.
27   *
28   * @Author KSContractMojo
29   * @Author Kamal
30   * @Since Mon Jan 11 15:20:51 PST 2010
31   * @See <a href="https://test.kuali.org/confluence/display/KULSTU/currencyAmountInfo+Structure+v1.0-rc1">CurrencyAmountInfo</>
32   *
33   */
34  @XmlAccessorType(XmlAccessType.FIELD)
35  public class CurrencyAmountInfo implements Serializable {
36  
37      private static final long serialVersionUID = 1L;
38  
39      @XmlAttribute
40      private String id;
41      
42      @XmlElement
43      private String currencyTypeKey;
44  
45      @XmlElement
46      private Integer currencyQuantity;
47      
48      @XmlElement
49      private MetaInfo metaInfo;
50  
51      /**
52       * The kind of units associated with the quantity, such as US Dollars
53       */
54      public String getCurrencyTypeKey() {
55          return currencyTypeKey;
56      }
57  
58      public void setCurrencyTypeKey(String currencyTypeKey) {
59          this.currencyTypeKey = currencyTypeKey;
60      }
61  
62      /**
63       * The amount of currency
64       */
65      public Integer getCurrencyQuantity() {
66          return currencyQuantity;
67      }
68  
69      public void setCurrencyQuantity(Integer currencyQuantity) {
70          this.currencyQuantity = currencyQuantity;
71      }
72  
73  	/**
74  	 * 	Identifier for the currency amount record.
75  	 */
76  	public String getId() {
77  		return id;
78  	}
79  
80  	public void setId(String id) {
81  		this.id = id;
82  	}
83  
84  	/**
85  	 * Create and last update info for the structure. This is optional and 
86  	 * treated as read only since the data is set by the internals of the
87  	 * service during maintenance operations.
88  	 */
89  	public MetaInfo getMetaInfo() {
90  		return metaInfo;
91  	}
92  
93  	public void setMetaInfo(MetaInfo metaInfo) {
94  		this.metaInfo = metaInfo;
95  	}
96  }