org.kuali.rice.krad.uif.container

Interface CollectionFilter

All Superinterfaces:

Serializable

All Known Implementing Classes:

ActiveCollectionFilter, ELCollectionFilter, MaintenanceActiveCollectionFilter

public interface CollectionFilter
extends Serializable

Provides filtering on collection data within a CollectionGroup

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method and Description
List<Integer>	filter(View view, Object model, CollectionGroup collectionGroup) Invoked to filter the collection data before the collection group is built.

Method Detail

filter

List<Integer> filter(View view,
                     Object model,
                     CollectionGroup collectionGroup)

Invoked to filter the collection data before the collection group is built. Note the collection should be retrieved from the model and the valid row indexes must be returned in the return list

Parameters:

view - - view instance for the collection group

model - - object containing the view data and from which the collection should be pulled/updated

collectionGroup - - collection group instance containing configuration for the collection

Returns:

the list that contains valid row indexes