Package org.cyclos.impl.system

Class CustomWizardExecutionStorage

java.lang.Object

org.cyclos.utils.AbstractParameterStorage

org.cyclos.server.utils.JacksonParameterStorage

org.cyclos.entities.utils.EntityBackedParameterStorage

org.cyclos.impl.system.CustomWizardExecutionStorage

All Implemented Interfaces:

ObjectParameterStorage, ParameterStorage

public class CustomWizardExecutionStorage
extends EntityBackedParameterStorage

A dedicated EntityBackedParameterStorage which has a list of getters / setters for well-known attributes

Field Summary

Fields inherited from class org.cyclos.server.utils.JacksonParameterStorage

node, objectMapper

Constructor Summary

Constructors

Constructor	Description
CustomWizardExecutionStorage(com.fasterxml.jackson.databind.ObjectMapper objectMapper, CustomWizardExecution entity, ConversionHandler conversionHandler)

Method Summary

Modifier and Type	Method	Description
void	clearNotification()	Clears any pending notification message
void	error(String message)	Sends an error notification
Map<String,Object>	getCustomValues()
String	getEmailToVerify()
String	getExternalPaymentToken()
Long	getIdentityProviderId()
IdentityProviderProfile	getIdentityProviderProfile()
InviteToken	getInviteToken()
MenuItem	getMenuItem()
NotificationLevel	getNotificationLevel()
String	getNotificationMessage()
PublicRegistrationDTO	getRegistration()
String	getSmsToVerify()
List<CustomWizardStepWithTransitions>	getSteps()
String	getUserAgentId()
String	getVerifiedEmail()
String	getVerifiedSms()
void	info(String message)	Sends an information notification
boolean	isCaptchaValidated()
boolean	isStepExecuted(CustomWizardStep step)
void	notify(NotificationLevel level, String message)	Sends a notification with a given type
void	setCaptchaValidated(boolean validated)
void	setCustomValues(Map<String,Object> map)
void	setEmailToVerify(String address)
void	setExternalPaymentToken(String externalPaymentToken)
void	setIdentityProviderId(Long id)
void	setIdentityProviderProfile(IdentityProviderProfile profile)
void	setInviteToken(InviteToken inviteToken)
void	setMenuItem(MenuItem item)
void	setRegistration(PublicRegistrationDTO registration)
void	setSmsToVerify(String number)
void	setStepExecuted(CustomWizardStep step, boolean executed)	Marks the given step as already executed.
void	setSteps(List<CustomWizardStepWithTransitions> steps)
void	setUserAgentId(String userAgentId)
void	setVerifiedEmail(String email)
void	setVerifiedSms(String number)
void	warn(String message)	Sends a warning notification

Methods inherited from class org.cyclos.entities.utils.EntityBackedParameterStorage

onChange

Methods inherited from class org.cyclos.server.utils.JacksonParameterStorage

cache, doSet, getNames, getObject, getString, getStringList, propertyMissing, propertyMissing, remove, setInput, setObject, toString

Methods inherited from class org.cyclos.utils.AbstractParameterStorage

getBoolean, getDate, getDecimal, getDecimalList, getEnum, getEnumList, getInteger, getIntegerList, getLong, getLongList, isSet, setBoolean, setDate, setDecimal, setEnum, setInteger, setLong, setString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.utils.ParameterStorage

addBoolean, addDate, addDecimal, addEnum, addInteger, addLong, addString, getBoolean, getDate, getDecimal, getDecimalList, getEnum, getEnumList, getInteger, getIntegerList, getLong, getLongList, isSet, setBoolean, setDate, setDecimal, setEnum, setInteger, setLong, setString

Constructor Detail

CustomWizardExecutionStorage

public CustomWizardExecutionStorage(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                    CustomWizardExecution entity,
                                    ConversionHandler conversionHandler)

Method Detail

clearNotification

public void clearNotification()

Clears any pending notification message

error

public void error(String message)

Sends an error notification

getCustomValues

public Map<String,Object> getCustomValues()

getEmailToVerify

public String getEmailToVerify()

getExternalPaymentToken

public String getExternalPaymentToken()

getIdentityProviderId

public Long getIdentityProviderId()

getIdentityProviderProfile

public IdentityProviderProfile getIdentityProviderProfile()

getInviteToken

public InviteToken getInviteToken()

getMenuItem

public MenuItem getMenuItem()

getNotificationLevel

public NotificationLevel getNotificationLevel()

getNotificationMessage

public String getNotificationMessage()

getRegistration

public PublicRegistrationDTO getRegistration()

getSmsToVerify

public String getSmsToVerify()

getSteps

public List<CustomWizardStepWithTransitions> getSteps()

getUserAgentId

public String getUserAgentId()

getVerifiedEmail

public String getVerifiedEmail()

getVerifiedSms

public String getVerifiedSms()

info

public void info(String message)

Sends an information notification

isCaptchaValidated

public boolean isCaptchaValidated()

isStepExecuted

public boolean isStepExecuted(CustomWizardStep step)

notify

public void notify(NotificationLevel level,
                   String message)

Sends a notification with a given type

setCaptchaValidated

public void setCaptchaValidated(boolean validated)

setCustomValues

public void setCustomValues(Map<String,Object> map)

setEmailToVerify

public void setEmailToVerify(String address)

setExternalPaymentToken

public void setExternalPaymentToken(String externalPaymentToken)

setIdentityProviderId

public void setIdentityProviderId(Long id)

setIdentityProviderProfile

public void setIdentityProviderProfile(IdentityProviderProfile profile)

setInviteToken

public void setInviteToken(InviteToken inviteToken)

setMenuItem

public void setMenuItem(MenuItem item)

setRegistration

public void setRegistration(PublicRegistrationDTO registration)

setSmsToVerify

public void setSmsToVerify(String number)

setStepExecuted

public void setStepExecuted(CustomWizardStep step,
                            boolean executed)

Marks the given step as already executed. It means that if the user goes back and forward again, nothing will be shown, except that the step was already executed, with a next button.

setSteps

public void setSteps(List<CustomWizardStepWithTransitions> steps)

setUserAgentId

public void setUserAgentId(String userAgentId)

setVerifiedEmail

public void setVerifiedEmail(String email)

setVerifiedSms

public void setVerifiedSms(String number)

warn

public void warn(String message)

Sends a warning notification