org.forgerock.openam.auth.node.api

Interface OutcomeProvider

public interface OutcomeProvider

Describes the outcomes for node instances.

Method Summary

Modifier and Type	Method and Description
List<OutcomeProvider.Outcome>	getOutcomes(PreferredLocales locales, JsonValue nodeAttributes) Returns a ordered list of possible node outcomes with localised display names.

Method Detail

getOutcomes

List<OutcomeProvider.Outcome> getOutcomes(PreferredLocales locales,
                                          JsonValue nodeAttributes)
                                   throws NodeProcessException

Returns a ordered list of possible node outcomes with localised display names.

Parameters:

locales - The locales for the localised description.

nodeAttributes - Unvalidated node attributes submitted in the request.

Returns:

A non-null list of outcomes. May be empty.

Throws:

NodeProcessException - If outcomes could not be determined.