com.cgiams.esl.service
Interface ValueListResultContext

All Known Implementing Classes:
ValueListResultContextImpl

public interface ValueListResultContext

This specifies the required API for the objects returned from the ValueListHandlerService.

Author:
sbowers

Method Summary
 java.lang.String getListID()
          This method returns the ID associated with this particular result context object.
 java.util.List getListOfValues()
          This method retrieves the current list of values generated from the ValueListHandler.getValueObjects() method call.
 boolean hasMoreValues()
          Call this method to determine whether the list contained in this result context is the complete list of values.
 

Method Detail

getListID

public java.lang.String getListID()
                           throws java.lang.IllegalStateException
This method returns the ID associated with this particular result context object. It is the same ID that was used when calling the ValueListHandler.getValueObjects() method.

Returns:
The id used to produce this list of value objects.
Throws:
java.lang.IllegalStateException - If the ID is empty or null.

hasMoreValues

public boolean hasMoreValues()
Call this method to determine whether the list contained in this result context is the complete list of values.

Returns:
False if the list within this object represents all the values returned from the ValueListHandler.getValueObjects() call, otherwise True.

getListOfValues

public java.util.List getListOfValues()
This method retrieves the current list of values generated from the ValueListHandler.getValueObjects() method call. Each item from the list is a Java Object and must be explicitly cast to the final object type.

Returns:
A List of value objects.