01: /*
02: * Copyright 2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
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.module.gl.service;
17:
18: import java.util.Iterator;
19:
20: import org.kuali.module.gl.bo.OriginEntryGroup;
21: import org.kuali.module.gl.bo.OriginEntryLite;
22:
23: /**
24: * An interface declaring methods that interact with OriginEntryLite objects. OriginEntryLite objects
25: * hold all the base data of OriginEntry, but don't have any references, which means that the O/RM layer
26: * can read them much quicker. Most of the OriginEntryFull methods are covered by OriginEntryService.
27: */
28: public interface OriginEntryLiteService {
29: /**
30: * Return all the entries in a specific group
31: *
32: * @param oeg Group used to select entries
33: * @return Iterator to all the entires
34: */
35: public Iterator<OriginEntryLite> getEntriesByGroup(
36: OriginEntryGroup oeg);
37:
38: /**
39: * Return all the entries for a specific document in a specific group
40: *
41: * @param oeg the origin entry group to find entries in
42: * @param documentNumber the document number of origin entries to return
43: * @param documentTypeCode the document type code of origin entries to return
44: * @param originCode the origination code to return
45: * @return iterator to all qualifying entries
46: */
47: public Iterator<OriginEntryLite> getEntriesByDocument(
48: OriginEntryGroup oeg, String documentNumber,
49: String documentTypeCode, String originCode);
50:
51: /**
52: * Saves an origin entry lite object to the database
53: *
54: * @param entry an entry to save
55: */
56: public void save(OriginEntryLite entry);
57:
58: /**
59: * Deletes an origin entry record from the database
60: *
61: * @param entry the entry to delete
62: */
63: public void delete(OriginEntryLite entry);
64: }
|