Package org.cyclos.entities.system

Class CustomWizard

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.NamedEntity

org.cyclos.entities.ConfigurationEntity

org.cyclos.entities.ConfigurationOrderableEntity

org.cyclos.entities.system.CustomWizard

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasNetwork, HasOrder, HasSvgIcon, ProcessableForProxying, DefinesNetwork, IEntity, IInternalNamedEntity, INamedEntity, UsesScript

Direct Known Subclasses:

RegistrationWizard, WizardWithChannels

@Entity
public abstract class CustomWizard
extends ConfigurationOrderableEntity
implements HasSvgIcon, DefinesNetwork, UsesScript

A custom wizard is a series of steps to perform an operation

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Field Summary

Fields

Modifier and Type	Field	Description
protected TimeInterval	incompleteRegistrationNotifyInterval

Constructor Summary

Constructors

Constructor	Description
CustomWizard()

Method Summary

Modifier and Type	Method	Description
List<CustomWizardField>	getCustomFields()
DataTranslationType	getDataTranslationType()	If this entity allows data translation, should return the translation type
abstract CustomWizardNature	getNature()
Network	getNetwork()	Returns the network this entity belongs to
CustomWizardResultType	getResultType()
CustomScript	getScript()
String	getScriptParameters()
CustomScriptUsedInType	getScriptUsedInType()	Returns the type of script usage
List<CustomWizardStep>	getSteps()
String	getSvgIcon()
boolean	isRequireConfirmationCredential()
boolean	isShowProgress()
void	setCustomFields(List<CustomWizardField> customFields)
void	setNetwork(Network network)
void	setRequireConfirmationCredential(boolean requireConfirmationCredential)
void	setResultType(CustomWizardResultType resultType)
void	setScript(CustomScript script)
void	setScriptParameters(String scriptParameters)
void	setShowProgress(boolean showProgress)
void	setSteps(List<CustomWizardStep> steps)
void	setSvgIcon(String svgIcon)

Methods inherited from class org.cyclos.entities.ConfigurationOrderableEntity

compareTo, getOrder, setOrder, toString

Methods inherited from class org.cyclos.entities.ConfigurationEntity

getDescription, getInternalName, setDescription, setInternalName, toShortString

Methods inherited from class org.cyclos.entities.NamedEntity

getName, getNames, setName

Methods inherited from class org.cyclos.entities.BaseEntity

getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.model.IInternalNamedEntity

matches

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Methods inherited from interface org.cyclos.model.system.scripts.UsesScript

isEnabled

Field Detail

incompleteRegistrationNotifyInterval

protected TimeInterval incompleteRegistrationNotifyInterval

Constructor Detail

CustomWizard

public CustomWizard()

Method Detail

getCustomFields

public List<CustomWizardField> getCustomFields()

getDataTranslationType

public DataTranslationType getDataTranslationType()

Description copied from class: BaseEntity

If this entity allows data translation, should return the translation type

Overrides:

getDataTranslationType in class BaseEntity

getNature

public abstract CustomWizardNature getNature()

getNetwork

public Network getNetwork()

Description copied from interface: HasNetwork

Returns the network this entity belongs to

Specified by:

getNetwork in interface HasNetwork

getResultType

public CustomWizardResultType getResultType()

getScript

public CustomScript getScript()

getScriptParameters

public String getScriptParameters()

getScriptUsedInType

public CustomScriptUsedInType getScriptUsedInType()

Description copied from interface: UsesScript

Returns the type of script usage

Specified by:

getScriptUsedInType in interface UsesScript

getSteps

public List<CustomWizardStep> getSteps()

getSvgIcon

public String getSvgIcon()

Specified by:

getSvgIcon in interface HasSvgIcon

isRequireConfirmationCredential

public boolean isRequireConfirmationCredential()

isShowProgress

public boolean isShowProgress()

setCustomFields

public void setCustomFields(List<CustomWizardField> customFields)

setNetwork

public void setNetwork(Network network)

Specified by:

setNetwork in interface DefinesNetwork

setRequireConfirmationCredential

public void setRequireConfirmationCredential(boolean requireConfirmationCredential)

setResultType

public void setResultType(CustomWizardResultType resultType)

setScript

public void setScript(CustomScript script)

setScriptParameters

public void setScriptParameters(String scriptParameters)

setShowProgress

public void setShowProgress(boolean showProgress)

setSteps

public void setSteps(List<CustomWizardStep> steps)

setSvgIcon

public void setSvgIcon(String svgIcon)

Specified by:

setSvgIcon in interface HasSvgIcon