Interface ProgressStage<C extends StageConfig>

    • Method Detail

      • gatherInitialRequirements

        JsonValue gatherInitialRequirements​(ProcessContext context,
                                            C config)
                                     throws ResourceException
        Response for defining any initial requirements the stage may have.

        An empty json object implies no initial requirements.

        Parameters:
        context - the current process context
        config - the stage configuration
        Returns:
        json value representing the requirements or empty json object for no requirements
        Throws:
        ResourceException - if some expected state is invalid
      • advance

        StageResponse advance​(ProcessContext context,
                              C config)
                       throws ResourceException
        Advance the progress stage.
        Parameters:
        context - the current process context
        config - the stage configuration
        Returns:
        the result of invoking this stage
        Throws:
        ResourceException - if some expected state or input is invalid