All Superinterfaces:

CRUDService<CustomWizardDTO,CustomWizardData,CustomWizardNature>, Service

All Known Subinterfaces:

CustomWizardServiceLocal

All Known Implementing Classes:

CustomWizardServiceImpl, CustomWizardServiceSecurity
```
public interface CustomWizardService
extends CRUDService<CustomWizardDTO,CustomWizardData,CustomWizardNature>
```
Service for managing custom wizards

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CustomWizardExecutionData`	`back(@NotNull CustomWizardBackParams params)`	Backs one or more steps
`void`	`cancel(@NotNull String key)`	Cancels the execution with the given key
`CustomWizardExecutionData`	`current(@NotNull String key)`	Returns the execution data for the current wizard step
`String`	`externalRedirect(@NotNull CustomWizardTransitionParams params)`	Prepares the redirection of the user to an external system.
`List<CustomWizardResultVO>`	`list()`	Lists all available custom wizards
`CustomWizardExecutionData`	`runExternalRedirectCallback(@NotNull RunExternalRedirectCallbackParams params)`	Runs the callback for a step which performs such operation
`void`	`saveOrder(@NotNull List<Long> ids)`	Saves the order according to the given wizard ids
`void`	`sendVerificationCode(@NotNull CustomWizardVerificationCodeParams params)`	Sends the verification code to either via email or by SMS, in order to verify the given data.
`CustomWizardExecutionData`	`start(@NotNull StartCustomWizardParams params)`	Starts the execution of a given wizard
`CustomWizardExecutionData`	`transition(@NotNull CustomWizardTransitionParams params)`	Transition a wizard between steps or finishes the wizard

Methods inherited from interface org.cyclos.services.CRUDService
getData, getDataForNew, load, remove, removeAll, save

Method Detail

back

CustomWizardExecutionData back(@NotNull
                               @NotNull CustomWizardBackParams params)
                        throws FrameworkException

Backs one or more steps

Throws:: FrameworkException

cancel

void cancel(@NotNull
            @NotNull String key)
     throws FrameworkException

Cancels the execution with the given key

Throws:: FrameworkException

current

CustomWizardExecutionData current(@NotNull
                                  @NotNull String key)
                           throws FrameworkException

Returns the execution data for the current wizard step

Throws:: FrameworkException

externalRedirect

String externalRedirect(@NotNull
                        @NotNull CustomWizardTransitionParams params)
                 throws FrameworkException

Prepares the redirection of the user to an external system.

Throws:: FrameworkException

list

List<CustomWizardResultVO> list()
                         throws FrameworkException

Lists all available custom wizards

Throws:: FrameworkException

runExternalRedirectCallback

CustomWizardExecutionData runExternalRedirectCallback(@NotNull
                                                      @NotNull RunExternalRedirectCallbackParams params)
                                               throws FrameworkException

Runs the callback for a step which performs such operation

Throws:: FrameworkException

saveOrder

void saveOrder(@NotNull
               @NotNull List<Long> ids)
        throws FrameworkException

Saves the order according to the given wizard ids

Throws:: FrameworkException

sendVerificationCode
```
void sendVerificationCode(@NotNull
                          @NotNull CustomWizardVerificationCodeParams params)
                   throws FrameworkException
```
Sends the verification code to either via email or by SMS, in order to verify the given data. Each send medium can only be used every 30 seconds.

Throws:

FrameworkException

start

CustomWizardExecutionData start(@NotNull
                                @NotNull StartCustomWizardParams params)
                         throws FrameworkException

Starts the execution of a given wizard

Throws:: FrameworkException

transition

CustomWizardExecutionData transition(@NotNull
                                     @NotNull CustomWizardTransitionParams params)
                              throws FrameworkException

Transition a wizard between steps or finishes the wizard

Throws:: FrameworkException

Interface CustomWizardService