org.kuali.kfs.integration.ld
Interface SegmentedBusinessObject

All Known Implementing Classes:

LedgerBalanceForBenefitExpenseTransfer, LedgerBalanceForSalaryExpenseTransfer

public interface SegmentedBusinessObject

Labor business object for SegmentedBusinessObject Used mostly for lookups. This interface is useful when segmenting lookup results. For example, If you wanted to split results for amounts in July, August, September, November, etc..., into separate records, this would helpful in doing that.

See Also:

BusinessObject

Method Summary

String	getAdditionalReturnData(String segmentedPropertyName) Returns String to append to the returned object id
Collection<String>	getSegmentedPropertyNames() Retrieve a collection of the property names to base the business object segmentation on
boolean	isLookupResultsSegmented() Determines whether to apply segments to lookup results

Method Detail

isLookupResultsSegmented

boolean isLookupResultsSegmented()

Determines whether to apply segments to lookup results

Returns:

boolean

getSegmentedPropertyNames

Collection<String> getSegmentedPropertyNames()

Retrieve a collection of the property names to base the business object segmentation on

Returns:

a collection of the property names to base the business object segmentation on

getAdditionalReturnData

String getAdditionalReturnData(String segmentedPropertyName)

Returns String to append to the returned object id

Parameters:

segmentedPropertyName - - name of the segmented property for the instance

Returns:

String that will be used for object id