Package org.forgerock.openam.auth.node.api

Interface BoundedOutcomeProvider

All Superinterfaces:

OutcomeProvider

@Supported
public interface BoundedOutcomeProvider
extends OutcomeProvider

Provides outcomes for nodes that have a variable set of predefined outcomes.

The outcomes returned by OutcomeProvider.getOutcomes(PreferredLocales, JsonValue) must always be a subset of the configuration-agnostic list of predefined outcomes provided by getAllOutcomes(PreferredLocales).

Nested Class Summary

Nested classes/interfaces inherited from interface org.forgerock.openam.auth.node.api.OutcomeProvider

OutcomeProvider.Outcome

Method Summary

Modifier and Type	Method	Description
List<OutcomeProvider.Outcome>	getAllOutcomes(PreferredLocales locales)	Returns a list of all possible outcomes for the node.

Methods inherited from interface org.forgerock.openam.auth.node.api.OutcomeProvider

getOutcomes

Method Details

getAllOutcomes

@Supported
List<OutcomeProvider.Outcome> getAllOutcomes(PreferredLocales locales)
                                      throws NodeProcessException

Returns a list of all possible outcomes for the node.

Parameters:

locales - The locales for the localised description.

Returns:

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

Throws:

NodeProcessException - If outcomes could not be determined.