class WizardRunScript extends EnvironmentFacades with ScriptBase with Facades

Base class implicitly used in all wizard implementations. It defines the wizard building blocks and useful properties that are made available to the wizard during execution.

A wizard implementation has one or more numbered pages and for each page both the WizardRunScript.init and the WizardRunScript.run functions must be called. The former determines what is displayed on the page initially and the latter determines what happens when the user advances the wizard to the next page.

Linear Supertypes
ScriptBase, EnvironmentFacades, FacadesWithRunner, Facades, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WizardRunScript
  2. ScriptBase
  3. EnvironmentFacades
  4. FacadesWithRunner
  5. Facades
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WizardRunScript(environment: String)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. var _cancel: Map[Int, WizardPageScript]
    Attributes
    protected
  5. def _executeCancel(pageNumber: Int, context: StageContext): MutableList[WizardLogMessage]
  6. def _executeInit(state: LiveSessionState, pageNumber: Int, context: StageContext): MutableList[WizardLogMessage]
  7. def _executeRun(state: LiveSessionState, pageNumber: Int, context: StageContext): MutableList[WizardLogMessage]
  8. def _executeSuccess(context: StageContext): Any
  9. var _init: Map[Int, WizardPageScript]
    Attributes
    protected
  10. var _page: PageApi
    Attributes
    protected
  11. var _run: Map[Int, WizardPageScript]
    Attributes
    protected
  12. var _session: SessionApi
    Attributes
    protected
  13. var _success: WizardPageScript
    Attributes
    protected
  14. var _wizard: WizardApi
    Attributes
    protected
  15. def application: ApplicationFacade

    The API for the Application Service.

    The API for the Application Service.

    Definition Classes
    EnvironmentFacades → Facades
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def cancel(page: Int)(func: ⇒ Unit): Unit

    Implements the optional cancel action for a wizard page.

    Implements the optional cancel action for a wizard page. The action should be implemented to reverse all side effects, which occurred as the wizard was advanced to the current page. Typically such effects would be from the run action on the page before.

    page

    The page number.

    func

    The function implementing the cancel action.

  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  19. def config: ConfigFacade

    The API for the Config Service.

    The API for the Config Service.

    Definition Classes
    EnvironmentFacades → Facades
  20. val environment: String
    Definition Classes
    EnvironmentFacades
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def facades: EnvironmentFacades
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def init(page: Int, async: Boolean = false)(func: ⇒ Unit): Unit

    Implements the init action for a wizard page.

    Implements the init action for a wizard page. The action should be implemented to setup the page as presented to the user with informative texts and input fields. The implementation should generally be free from side effects and validation code.

    page

    The page number.

    async

    Whether to run the action asynchronously. Should be used for actions taking more than a few seconds.

    func

    The function implementing the init action.

  27. def isAsyncInit(page: Int): Boolean

    Whether an init action is asynchronous.

  28. def isAsyncRun(page: Int): Boolean

    Whether a run action is asynchronous.

  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def numberOfPages: Int

    The wizard page count.

  34. def output: OutputFacade

    The API for the Output Service.

    The API for the Output Service.

    Definition Classes
    EnvironmentFacades → Facades
  35. def page: PageApi

    Provides access to methods for building a wizard page.

  36. def query: QueryFacade

    The API for the Query Service.

    The API for the Query Service.

    Definition Classes
    EnvironmentFacades → Facades
  37. def run(page: Int, async: Boolean = false)(func: ⇒ Unit): Unit

    Implements the run action for a wizard page.

    Implements the run action for a wizard page. The action should be implemented to perform the desired effects based on the input from the user. This is the place to include validation code for user input and any externally visible side effects (consider though to implement a cancel action for any significant side effects).

    page

    The page number.

    async

    Whether to run the action asynchronously. Should be used for actions taking more than a few seconds.

    func

    The function implementing the run action.

  38. def runner(name: String): RunnerFacade

    The API for the Runner Service with a given name.

    The API for the Runner Service with a given name.

    name

    The service name of the runner.

    Definition Classes
    EnvironmentFacades → FacadesWithRunner
  39. def scheduler: SchedulerFacade

    The API for the Scheduler Service.

    The API for the Scheduler Service.

    Definition Classes
    EnvironmentFacades → Facades
  40. def session: SessionApi

    Provides access to methods for interacting with the current wizard session.

  41. def success(func: ⇒ Unit): Unit

    Implements the optional success action for a wizard page.

    Implements the optional success action for a wizard page. This action follows the run action for the final page and should be implemented to inform the user of the wizards successful completion and summarize any final results you wish to present.

    func

    The function implementing the success action.

  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. def validate(): Unit

    Performs some simple validations of the wizard structure.

    Performs some simple validations of the wizard structure. This function is called internally and should not be used by implementers.

  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def wizard: WizardApi

    Provides access to methods and properties for interacting with the wizard state.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from ScriptBase

Inherited from EnvironmentFacades

Inherited from FacadesWithRunner

Inherited from Facades

Inherited from AnyRef

Inherited from Any

Ungrouped