org.kuali.rice.kns.service
Interface InactivateableFromToService

All Known Implementing Classes:

InactivateableFromToServiceImpl

public interface InactivateableFromToService

Provides methods for retrieval of business objects implementing InactivateableFromTo and needing effective dating logic

See Also:

InactivateableFromTo

Method Summary

List<InactivateableFromTo>	filterOutNonActive(List<InactivateableFromTo> filterList) Removes instances from the given list that are inactive based on the current date
List<InactivateableFromTo>	filterOutNonActive(List<InactivateableFromTo> filterList, Date activeAsOfDate) Removes instances from the given list that are inactive based on the given date
List<InactivateableFromTo>	filterOutNonCurrent(List<InactivateableFromTo> filterList) Removes instances from the given list that are not current based on the current date
List<InactivateableFromTo>	filterOutNonCurrent(List<InactivateableFromTo> filterList, Date currentAsOfDate) Removes instances from the given list that are not current based on the given date
List<InactivateableFromTo>	findMatchingActive(Class<? extends InactivateableFromTo> clazz, Map fieldValues) Performs search on given class and criteria and returns only results that active based on the active to/from dates and the current date
List<InactivateableFromTo>	findMatchingActiveAsOfDate(Class<? extends InactivateableFromTo> clazz, Map fieldValues, Date activeAsOfDate) Performs search on given class and criteria and returns only results that active based on the active to/from dates and the given active as of date
List<InactivateableFromTo>	findMatchingCurrent(Class<? extends InactivateableFromTo> clazz, Map fieldValues) Performs search on given class and criteria and returns that are active and most current.
List<InactivateableFromTo>	findMatchingCurrent(Class<? extends InactivateableFromTo> clazz, Map fieldValues, Date currentAsOfDate) Performs search on given class and criteria and returns that are active and most current based on the given date.

Method Detail

findMatchingActive

List<InactivateableFromTo> findMatchingActive(Class<? extends InactivateableFromTo> clazz,
                                              Map fieldValues)

Performs search on given class and criteria and returns only results that active based on the active to/from dates and the current date

Parameters:

clazz - - InactivateableFromTo class to search

fieldValues - - Search key values

Returns:

List of InactivateableFromTo instances that match search criteria and are active

findMatchingActiveAsOfDate

List<InactivateableFromTo> findMatchingActiveAsOfDate(Class<? extends InactivateableFromTo> clazz,
                                                      Map fieldValues,
                                                      Date activeAsOfDate)

Performs search on given class and criteria and returns only results that active based on the active to/from dates and the given active as of date

Parameters:

clazz - - InactivateableFromTo class to search

fieldValues - - Search key values

activeAsOfDate - - Date to compare to for determining active status

Returns:

List of InactivateableFromTo instances that match search criteria and are active as of the given date

filterOutNonActive

List<InactivateableFromTo> filterOutNonActive(List<InactivateableFromTo> filterList)

Removes instances from the given list that are inactive based on the current date

Parameters:

filterList - - List of InactivateableFromTo instances to filter

Returns:

List of InactivateableFromTo instances from the given list that are active as of the current date

filterOutNonActive

List<InactivateableFromTo> filterOutNonActive(List<InactivateableFromTo> filterList,
                                              Date activeAsOfDate)

Removes instances from the given list that are inactive based on the given date

Parameters:

filterList - - List of InactivateableFromTo instances to filter

activeAsOfDate - - Date to compare to for determining active status

Returns:

List of InactivateableFromTo instances from the given list that are active as of the given date

findMatchingCurrent

List<InactivateableFromTo> findMatchingCurrent(Class<? extends InactivateableFromTo> clazz,
                                               Map fieldValues)

Performs search on given class and criteria and returns that are active and most current. That is if two records are active the more current one will be the one with a later active begin date

Parameters:

clazz - - InactivateableFromTo class to search

fieldValues - - Search key values

Returns:

List of InactivateableFromTo instances that match search criteria and are current

findMatchingCurrent

List<InactivateableFromTo> findMatchingCurrent(Class<? extends InactivateableFromTo> clazz,
                                               Map fieldValues,
                                               Date currentAsOfDate)

Performs search on given class and criteria and returns that are active and most current based on the given date. That is if two records are active the more current one will be the one with a later active begin date

Parameters:

clazz - - InactivateableFromTo class to search

fieldValues - - Search key values

currentAsOfDate - - Date to compare to for determining active and current status

Returns:

List of InactivateableFromTo instances that match search criteria and are current

filterOutNonCurrent

List<InactivateableFromTo> filterOutNonCurrent(List<InactivateableFromTo> filterList)

Removes instances from the given list that are not current based on the current date

Parameters:

filterList - - List of InactivateableFromTo instances to filter

Returns:

List of InactivateableFromTo instances from the given list that are current as of the current date

filterOutNonCurrent

List<InactivateableFromTo> filterOutNonCurrent(List<InactivateableFromTo> filterList,
                                               Date currentAsOfDate)

Removes instances from the given list that are not current based on the given date

Parameters:

filterList - - List of InactivateableFromTo instances to filter

currentAsOfDate - - Date to compare to for determining active and current status

Returns:

List of InactivateableFromTo instances from the given list that are current as of the given date