Interface Settings
-
- All Superinterfaces:
Identifiable
public interface Settings extends Identifiable
Definition for a settings.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addFavoriteHandlerVariant(FormLogicComponentVariantDefinition variant)
Adds a handler variant to the existing list of favorite handlers.ConditionalComponentDefinition
getConditionalComponentDefinition()
Returns the definition of the conditional 'formlogic' component.WorkflowModel
getDefaultWorkflowModel()
Returns the defaultWorkflowModel
for the interactive forms of theWebsite
to which thisSettings
object applies.List<FormHandlerDefinition>
getFavoriteFormHandlerDefinitions()
Returns a list of the favorite form handler definitions.List<FormFragmentComponent>
getFormFragmentComponents()
Returns a List of all FormFragmentComponents that are registerd in WebManager.List<FormHandlerDefinition>
getFormHandlerDefinitions()
Returns a list of all form handler definitions within an installation.List<FormLogicComponentDefinition>
getFormLogicComponentDefinitions()
Returns a list of all form logic component definitions within an installation.List<FormRouterDefinition>
getFormRouterDefinitions()
Returns a list of all form router definitions within an installation.List<FormValidatorDefinition>
getFormValidatorDefinitions()
Returns a list of all form validator definitions within an installation.List<FragmentValidatorDefinition>
getFragmentValidatorDefinitions()
Returns a list of all fragment validator definitions within an installation.Website
getWebsite()
Returns the Website for which this Settings object holds settings.void
removeFavoriteHandlerVariant(FormLogicComponentVariantDefinition variant)
Removes a handler variant from the existing list of favorite handlers.void
setFavoriteFormHandlerDefinitions(List<FormHandlerDefinition> definitions)
Sets a list of the favorite form handler definitions.void
setFormFragmentComponents(List<FormFragmentComponent> components)
Sets a List of all FormFragmentComponents that are registerd in WebManager.void
setFormHandlerDefinitions(List<FormHandlerDefinition> definitions)
Sets a list of all form handler definitions within an installation.void
setFormRouterDefinitions(List<FormRouterDefinition> definitions)
Sets a list of all form router definitions within an installation.void
setFormValidatorDefinitions(List<FormValidatorDefinition> definitions)
Sets a list of all form validator definitions within an installation.void
setFragmentValidatorDefinitions(List<FragmentValidatorDefinition> definitions)
Sets a list of all fragment validator definitions within an installation.void
setWebsite(Website website)
Sets the Website for which this Settings object holds settings.-
Methods inherited from interface nl.gx.webmanager.services.entitymanager.Identifiable
getId, setId
-
-
-
-
Method Detail
-
getWebsite
Website getWebsite()
Returns the Website for which this Settings object holds settings.- Returns:
- the Website for which this Settings object holds settings
-
setWebsite
void setWebsite(Website website)
Sets the Website for which this Settings object holds settings.- Parameters:
website
- the Website for which this Settings object holds settings
-
getFormFragmentComponents
List<FormFragmentComponent> getFormFragmentComponents()
Returns a List of all FormFragmentComponents that are registerd in WebManager.- Returns:
- a List of all FormFragmentComponents
-
setFormFragmentComponents
void setFormFragmentComponents(List<FormFragmentComponent> components)
Sets a List of all FormFragmentComponents that are registerd in WebManager.- Parameters:
components
- a List of all FormFragmentComponents that are registerd in WebManager.
-
getFormHandlerDefinitions
List<FormHandlerDefinition> getFormHandlerDefinitions()
Returns a list of all form handler definitions within an installation.- Returns:
- A list of all FormHandlerDefinitions within an installation.
-
setFormHandlerDefinitions
void setFormHandlerDefinitions(List<FormHandlerDefinition> definitions)
Sets a list of all form handler definitions within an installation.- Parameters:
definitions
- a list of all form handler definitions within an installation.
-
getFavoriteFormHandlerDefinitions
List<FormHandlerDefinition> getFavoriteFormHandlerDefinitions()
Returns a list of the favorite form handler definitions.- Returns:
- A list of the favorite FormHandlerDefinitions.
-
setFavoriteFormHandlerDefinitions
void setFavoriteFormHandlerDefinitions(List<FormHandlerDefinition> definitions)
Sets a list of the favorite form handler definitions.- Parameters:
definitions
- a list of the favorite form handler definitions.
-
getFormRouterDefinitions
List<FormRouterDefinition> getFormRouterDefinitions()
Returns a list of all form router definitions within an installation.- Returns:
- A list of all FormRouterDefinitions within an installation.
-
setFormRouterDefinitions
void setFormRouterDefinitions(List<FormRouterDefinition> definitions)
Sets a list of all form router definitions within an installation.- Parameters:
definitions
- a list of all form router definitions within an installation
-
getFragmentValidatorDefinitions
List<FragmentValidatorDefinition> getFragmentValidatorDefinitions()
Returns a list of all fragment validator definitions within an installation.- Returns:
- A list of all FragmentValidatorDefinitions within an installation.
-
setFragmentValidatorDefinitions
void setFragmentValidatorDefinitions(List<FragmentValidatorDefinition> definitions)
Sets a list of all fragment validator definitions within an installation.- Parameters:
definitions
- a list of all fragment validator definitions within an installation
-
getFormValidatorDefinitions
List<FormValidatorDefinition> getFormValidatorDefinitions()
Returns a list of all form validator definitions within an installation.- Returns:
- a list of all FormValidatorDefinitions within an installation.
-
setFormValidatorDefinitions
void setFormValidatorDefinitions(List<FormValidatorDefinition> definitions)
Sets a list of all form validator definitions within an installation.- Parameters:
definitions
- a list of all form validator definitions within an installation
-
getFormLogicComponentDefinitions
List<FormLogicComponentDefinition> getFormLogicComponentDefinitions()
Returns a list of all form logic component definitions within an installation.- Returns:
- a list of all form logic component definitions within an installation
-
getConditionalComponentDefinition
ConditionalComponentDefinition getConditionalComponentDefinition()
Returns the definition of the conditional 'formlogic' component. The conditional component is a special component which can contain handlers, routers and validators. A condition('expression') can be added which determines which routers, validators or handlers are executed. It has a construct as follows:
IF |condition| THEN
|conditional component|
|validators|
|handlers|
|routers|
ELSE
|conditional component|
|validators|
|handlers|
|routers|
ENDIF
NOTE(1): Within a conditional component one or more conditional components may be nested. They can be nested in the 'IF' or in the 'ELSE'.
NOTE(2): The nested conditional components can also be added after the handlers in the construct above. It is possible to add them after the routers but that would make no sense.- Returns:
- The definition of the conditional component.
-
getDefaultWorkflowModel
WorkflowModel getDefaultWorkflowModel()
Returns the defaultWorkflowModel
for the interactive forms of theWebsite
to which thisSettings
object applies.- Returns:
- the default
WorkflowModel
for the interactive forms of theWebsite
to which thisSettings
object applies
-
addFavoriteHandlerVariant
void addFavoriteHandlerVariant(FormLogicComponentVariantDefinition variant)
Adds a handler variant to the existing list of favorite handlers.- Parameters:
variant
- the handler variant definition to be added as favorite
-
removeFavoriteHandlerVariant
void removeFavoriteHandlerVariant(FormLogicComponentVariantDefinition variant)
Removes a handler variant from the existing list of favorite handlers.- Parameters:
variant
- the handler variant definition to be removed as favorite
-
-