org.kuali.rice.krms.api.engine
Interface EngineResults

All Known Implementing Classes:

EngineResultsImpl

public interface EngineResults

Results of an Engine's execution

Author:

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

See Also:

ResultEvent

Method Summary

void	addResult(ResultEvent result) Add the given ResultEvent
List<ResultEvent>	getAllResults() Return the list of ResultEvents
Object	getAttribute(String key) Return the attribute of the given key
ResultEvent	getResultEvent(int index) Deprecated. use getAllResults() instead, this method will be removed in a future version
List<ResultEvent>	getResultsOfType(String type) Return the ResultEvents of the given type
void	setAttribute(String key, Object attribute) Set the attribute of the given values

Method Detail

getResultEvent

@Deprecated
ResultEvent getResultEvent(int index)

Deprecated. use getAllResults() instead, this method will be removed in a future version

Return the ResultEvent for the given index

Parameters:

index - of the ResultEvent to return

Returns:

ResultEvent whose index was given

getAllResults

List<ResultEvent> getAllResults()

Return the list of ResultEvents

Returns:

List all the results

getResultsOfType

List<ResultEvent> getResultsOfType(String type)

Return the ResultEvents of the given type

Parameters:

type - of result events to return

Returns:

List of the given type

getAttribute

Object getAttribute(String key)

Return the attribute of the given key

Parameters:

key - to return the attribute of

Returns:

Object that is the attribute for the given key

setAttribute

void setAttribute(String key,
                  Object attribute)

Set the attribute of the given values

Parameters:

key - to set the given attribute of

attribute - to set as the given key's attribute

addResult

void addResult(ResultEvent result)

Add the given ResultEvent

Parameters:

result - to add