1 /*
2 * Copyright 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 package org.kuali.ole.fp.businessobject;
17
18 import java.sql.Date;
19
20 import org.apache.ojb.broker.PersistenceBrokerAware;
21 import org.kuali.rice.core.api.util.type.KualiDecimal;
22 import org.kuali.rice.krad.bo.PersistableBusinessObject;
23
24
25 /**
26 * This class represents a check is cashiering related documents
27 */
28 public interface Check extends PersistableBusinessObject, PersistenceBrokerAware {
29
30 /**
31 * Gets the checkDate attribute.
32 *
33 * @return Returns the checkDate.
34 */
35 public Date getCheckDate();
36
37 /**
38 * Sets the checkDate attribute value.
39 *
40 * @param checkDate The checkDate to set.
41 */
42 public void setCheckDate(Date checkDate);
43
44 /**
45 * Gets the checkNumber attribute.
46 *
47 * @return Returns the checkNumber.
48 */
49 public String getCheckNumber();
50
51 /**
52 * Sets the checkNumber attribute value.
53 *
54 * @param checkNumber The checkNumber to set.
55 */
56 public void setCheckNumber(String checkNumber);
57
58 /**
59 * Gets the description attribute.
60 *
61 * @return Returns the description.
62 */
63 public String getDescription();
64
65 /**
66 * Sets the description attribute value.
67 *
68 * @param description The description to set.
69 */
70 public void setDescription(String description);
71
72
73 /**
74 * Gets the sequenceId attribute.
75 *
76 * @return Returns the sequenceId.
77 */
78 public Integer getSequenceId();
79
80 /**
81 * Sets the sequenceId attribute value.
82 *
83 * @param sequenceId The sequenceId to set.
84 */
85 public void setSequenceId(Integer sequenceId);
86
87
88 /**
89 * Gets the amount attribute.
90 *
91 * @return Returns the amount.
92 */
93 public KualiDecimal getAmount();
94
95 /**
96 * Sets the amount attribute value.
97 *
98 * @param amount The amount to set.
99 */
100 public void setAmount(KualiDecimal amount);
101
102 /**
103 * Gets the documentNumber attribute.
104 *
105 * @return Returns the documentNumber.
106 */
107 public String getDocumentNumber();
108
109 /**
110 * Sets the documentNumber attribute value.
111 *
112 * @param documentNumber The documentNumber to set.
113 */
114 public void setDocumentNumber(String documentNumber);
115
116
117 /**
118 * Sets the financialDocumentDepositLineNumber.
119 *
120 * @param financialDocumentDepositLineNumber
121 */
122 public void setFinancialDocumentDepositLineNumber(Integer financialDocumentDepositLineNumber);
123
124 /**
125 * Gets the financialDocumentDepositLineNumber attribute.
126 *
127 * @return Returns the financialDocumentDepositLineNumber.
128 */
129 public Integer getFinancialDocumentDepositLineNumber();
130
131 /**
132 * Returns the document type that created this record.
133 *
134 * @return the document type of the creating document.
135 */
136 public String getFinancialDocumentTypeCode();
137
138 /**
139 * Sets the kind of document that created this check
140 *
141 * @param financialDocumentTypeCode
142 */
143 public void setFinancialDocumentTypeCode(String financialDocumentTypeCode);
144
145 /**
146 * Gets the code that describes where this cashiering record came from
147 *
148 * @return the cashiering record source
149 */
150 public String getCashieringStatus();
151
152 /**
153 * Sets the source of this cashiering record.
154 *
155 * @param cashieringStatus
156 */
157 public void setCashieringStatus(String cashieringStatus);
158
159 /**
160 * Returns true if this check has the same primitive field values as the given one
161 *
162 * @param other
163 * @return true if this Check has the same primitive field values as the given one
164 */
165 public boolean isLike(Check other);
166 }