001: /*
002: * Copyright 2006-2007 The Kuali Foundation.
003: *
004: * Licensed under the Educational Community License, Version 1.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/ecl1.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.module.financial.bo;
017:
018: import java.sql.Date;
019:
020: import org.apache.ojb.broker.PersistenceBrokerAware;
021: import org.kuali.core.bo.PersistableBusinessObject;
022: import org.kuali.core.util.KualiDecimal;
023:
024: /**
025: * This class represents a check is cashiering related documents
026: */
027: public interface Check extends PersistableBusinessObject,
028: PersistenceBrokerAware {
029:
030: /**
031: * Gets the checkDate attribute.
032: *
033: * @return Returns the checkDate.
034: */
035: public Date getCheckDate();
036:
037: /**
038: * Sets the checkDate attribute value.
039: *
040: * @param checkDate The checkDate to set.
041: */
042: public void setCheckDate(Date checkDate);
043:
044: /**
045: * Gets the checkNumber attribute.
046: *
047: * @return Returns the checkNumber.
048: */
049: public String getCheckNumber();
050:
051: /**
052: * Sets the checkNumber attribute value.
053: *
054: * @param checkNumber The checkNumber to set.
055: */
056: public void setCheckNumber(String checkNumber);
057:
058: /**
059: * Gets the description attribute.
060: *
061: * @return Returns the description.
062: */
063: public String getDescription();
064:
065: /**
066: * Sets the description attribute value.
067: *
068: * @param description The description to set.
069: */
070: public void setDescription(String description);
071:
072: /**
073: * Gets the sequenceId attribute.
074: *
075: * @return Returns the sequenceId.
076: */
077: public Integer getSequenceId();
078:
079: /**
080: * Sets the sequenceId attribute value.
081: *
082: * @param sequenceId The sequenceId to set.
083: */
084: public void setSequenceId(Integer sequenceId);
085:
086: /**
087: * Gets the amount attribute.
088: *
089: * @return Returns the amount.
090: */
091: public KualiDecimal getAmount();
092:
093: /**
094: * Sets the amount attribute value.
095: *
096: * @param amount The amount to set.
097: */
098: public void setAmount(KualiDecimal amount);
099:
100: /**
101: * Gets the documentNumber attribute.
102: *
103: * @return Returns the documentNumber.
104: */
105: public String getDocumentNumber();
106:
107: /**
108: * Sets the documentNumber attribute value.
109: *
110: * @param documentNumber The documentNumber to set.
111: */
112: public void setDocumentNumber(String documentNumber);
113:
114: /**
115: * Sets the financialDocumentDepositLineNumber.
116: *
117: * @param financialDocumentDepositLineNumber
118: */
119: public void setFinancialDocumentDepositLineNumber(
120: Integer financialDocumentDepositLineNumber);
121:
122: /**
123: * Gets the financialDocumentDepositLineNumber attribute.
124: *
125: * @return Returns the financialDocumentDepositLineNumber.
126: */
127: public Integer getFinancialDocumentDepositLineNumber();
128:
129: /**
130: * Returns the document type that created this record.
131: *
132: * @return the document type of the creating document.
133: */
134: public String getFinancialDocumentTypeCode();
135:
136: /**
137: * Sets the kind of document that created this check
138: *
139: * @param financialDocumentTypeCode
140: */
141: public void setFinancialDocumentTypeCode(
142: String financialDocumentTypeCode);
143:
144: /**
145: * Gets the code that describes where this cashiering record came from
146: *
147: * @return the cashiering record source
148: */
149: public String getCashieringRecordSource();
150:
151: /**
152: * Sets the source of this cashiering record.
153: *
154: * @param cashieringRecordSource
155: */
156: public void setCashieringRecordSource(String cashieringRecordSource);
157:
158: /**
159: * Returns true if this check has the same primitive field values as the given one
160: *
161: * @param other
162: * @return true if this Check has the same primitive field values as the given one
163: */
164: public boolean isLike(Check other);
165: }
|