To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A named, ordered group of steps within a Recipe, representing one phase of an account's setup checklist. Configured in an app's recipe XML as a "stage" element containing an ordered list of steps. Once a recipe is initialised, a stage exposes its steps, its task steps, and a lookup map keyed by step id so RecipeManager can resolve outcome transitions.
Group: Recipes
Properties
| Property | Returns | Description |
|---|---|---|
| firstStep | ActionRecipeStep | The first step in this stage, in configured order. Only populated after init has run. |
| id | String | Unique identifier for this stage within its recipe. |
| mapOfSteps | Map<String,RecipeStep> | This stage's steps keyed by step id, built lazily on first call. |
| steps | List<RecipeStep> | Every step configured in this stage, in order. |
| taskSteps | List<TaskRecipeStep> | The steps in this stage that are task steps, in configured order. Only populated after init has run. |
| title | String | Display title for this stage, shown to the account admin working through the recipe. |
Methods
copy() · withWebsiteHref(String href) · withTitle(String title) · withId(String s) · withSteps(List<RecipeStep> steps) · getTaskSteps() · getFirstStep() · getMapOfSteps() · step(String id) · getSteps() · getTitle() · getId()
copy()
Returns: RecipeStage
Creates an independent copy of this stage, including copies of every step.
withWebsiteHref(String href)
Returns: RecipeStage
Returns a copy of this stage with the given website href, the page a user is sent to after completing the stage.
| Parameter | Description |
|---|---|
href | the website href to set on the copy |
withTitle(String title)
Returns: RecipeStage
Returns a copy of this stage with the given title.
| Parameter | Description |
|---|---|
title | the title to set on the copy |
withId(String s)
Returns: RecipeStage
Returns a copy of this stage with the given id.
| Parameter | Description |
|---|---|
s | the id to set on the copy |
withSteps(List<RecipeStep> steps)
Returns: RecipeStage
Returns a copy of this stage with its steps replaced by the given list.
| Parameter | Description |
|---|---|
steps | the steps to set on the copy |
getTaskSteps()
Returns: List<TaskRecipeStep>
The steps in this stage that are task steps, in configured order. Only populated after init has run.
getFirstStep()
Returns: ActionRecipeStep
The first step in this stage, in configured order. Only populated after init has run.
getMapOfSteps()
Returns: Map<String,RecipeStep>
This stage's steps keyed by step id, built lazily on first call.
step(String id)
Returns: RecipeStep
Looks up a step in this stage by its id.
| Parameter | Description |
|---|---|
id | the id of the step to find |
getSteps()
Returns: List<RecipeStep>
Every step configured in this stage, in order.
getTitle()
Returns: String
Display title for this stage, shown to the account admin working through the recipe.
getId()
Returns: String
Unique identifier for this stage within its recipe.
© 2025 Kademi Ltd