com.cgiams.esl.service
Interface ValueListHandler

All Known Subinterfaces:
DataManager
All Known Implementing Classes:
CustomDataManagerImpl, DefaultDataManagerImpl

public interface ValueListHandler

This interface provides a Value List API used for retrieving results of value objects while hiding the data access details from the consumer.

Author:
sbowers

Method Summary
 ValueListResultContext getValueObjects(ValueListSearchContext ao_search_parms)
          Retrieves a list of value objects based on the incoming search parameters and returns the list in the ValueListResultContext.
 

Method Detail

getValueObjects

public ValueListResultContext getValueObjects(ValueListSearchContext ao_search_parms)
                                       throws ESLException
Retrieves a list of value objects based on the incoming search parameters and returns the list in the ValueListResultContext. The incoming search context specifies whether the retrieval is an initial retrieval or, possibly, asking for the next set of value objects.

Parameters:
ao_search_parms - A ValueListSearchContext object indicating how and what to retrieve.
Returns:
A ValueListResultContext object that provides a list of value objects and whether the list is complete or not.
Throws:
ESLException - If any error occurs.