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.labor.bo;
17:
18: import java.util.Collection;
19:
20: /**
21: * Labor business object for SegmentedBusinessObject Used mostly for lookups. This interface is useful when segmenting lookup
22: * results. For example, If you wanted to split results for amounts in July, August, September, November, etc..., into separate
23: * records, this would helpful in doing that.
24: *
25: * @see org.kuali.core.bo.BusinessObject
26: */
27: public interface SegmentedBusinessObject {
28:
29: /**
30: * Determines whether to apply segments to lookup results
31: *
32: * @return boolean
33: */
34: public boolean isLookupResultsSegmented();
35:
36: /**
37: * Retrieve a collection of the property names to base the business object segmentation on
38: *
39: * @return a collection of the property names to base the business object segmentation on
40: */
41: public Collection<String> getSegmentedPropertyNames();
42:
43: /**
44: * Returns String to append to the returned object id
45: *
46: * @param segmentedPropertyName - name of the segmented property for the instance
47: * @return String that will be used for object id
48: */
49: public String getAdditionalReturnData(String segmentedPropertyName);
50: }
|