1 /*
2 * Copyright 2007 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.module.cg.document;
17
18 import java.sql.Date;
19
20 import org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase;
21
22 /**
23 * Instances of CloseDocument indicate dates on which the {@link CloseBatchStep} should be executed.
24 */
25 public class CloseDocument extends FinancialSystemTransactionalDocumentBase {
26
27 protected Date userInitiatedCloseDate;
28 protected Date closeOnOrBeforeDate;
29
30 /**
31 * The {@link CloseBatchStep} will close out {@link Proposal}s and {@link Award}s not yet closed and created before the date
32 * returned from this method.
33 *
34 * @return the date to use for comparison. See method description.
35 */
36 public Date getUserInitiatedCloseDate() {
37 return userInitiatedCloseDate;
38 }
39
40 /**
41 * The {@link CloseBatchStep} will close out {@link Proposal}s and {@link Award}s not yet closed and created before the date
42 * passed into this method.
43 *
44 * @param closeOnOrBeforeDate the date to use for comparison. See method description.
45 */
46 public void setUserInitiatedCloseDate(Date userInitiatedCloseDate) {
47 this.userInitiatedCloseDate = userInitiatedCloseDate;
48 }
49
50 /**
51 * Gets the date on which this instance should trigger the CloseBatchStep to close out {@link {Proposal}s and {@link Award}s.
52 *
53 * @return the date on which this instance should trigger the CloseBatchStep to close out {@link {Proposal}s and {@link Award}s.
54 */
55 public Date getCloseOnOrBeforeDate() {
56 return closeOnOrBeforeDate;
57 }
58
59 /**
60 * Sets the date on which this instance should trigger the CloseBatchStep to close out {@link {Proposal}s and {@link Award}s.
61 *
62 * @param userInitiatedCloseDate the date on which this instance should trigger the CloseBatchStep to close out
63 * {@link {Proposal}s and {@link Award}s.
64 */
65 public void setCloseOnOrBeforeDate(Date closeOnOrBeforeDate) {
66 this.closeOnOrBeforeDate = closeOnOrBeforeDate;
67 }
68
69 }