StageResponse (org.gluufederation.commons.selfservice.core 2.0.11 Documentation)

java.lang.Object
- org.forgerock.selfservice.core.StageResponse

```
public final class StageResponse
extends Object
```
Stage response represents a response from having invoked a progress stage.

Since:

0.1.0

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`StageResponse.Builder`	Builder assists with the creation of `StageResponse` instances.
`static interface`	`StageResponse.RequirementsBuilder`	Requirements builder allows for the definition of a snapshot token callback, which gets invoked with just prior to requirements being sent to the client.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SnapshotTokenCallback`	`getCallback()`	Returns the callback instance.
`org.forgerock.json.JsonValue`	`getRequirements()`	Returns the requirements.
`String`	`getStageTag()`	Returns the stage tag.
`boolean`	`hasCallback()`	Returns `true` if the response contains a snapshot token callback instance.
`boolean`	`hasRequirements()`	Returns `true` if the response has any requirements.
`static StageResponse.Builder`	`newBuilder()`	New builder to help construct a stage response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getStageTag
```
public String getStageTag()
```
    Returns the stage tag.
    
    Returns:
    
    the stage tag
  - hasRequirements
```
public boolean hasRequirements()
```
    Returns true if the response has any requirements.
    
    Returns:
    
    true if the response has any requirements
  - getRequirements
```
public org.forgerock.json.JsonValue getRequirements()
```
    Returns the requirements.
    
    Returns:
    
    the requirements
  - hasCallback
```
public boolean hasCallback()
```
    Returns true if the response contains a snapshot token callback instance.
    
    Returns:
    
    true if the response contains a snapshot token callback instance
  - getCallback
```
public SnapshotTokenCallback getCallback()
```
    Returns the callback instance.
    
    Returns:
    
    the callback instance
  - newBuilder
```
public static StageResponse.Builder newBuilder()
```
    New builder to help construct a stage response.
    
    Returns:
    
    new builder