Annotation Interface SystemSetup
The
@SystemSetup is an annotation (as a hock-in mechanism) for executing methods during the init/update
process for given extensions.
With the annotation attribute extension you can specify, for which extension those methods should be
called. The init/update process will first search for the extension attribute in the method annotations and then in
this class annotation. You have to specify one of them. If the given extension does not exist, the method won't be
called. If the annotation attributes process or type is not defined at the method nor at
the class the default will be ALL then.
Please make sure that the class is initialized properly (for example via Spring).
Annotation attributes:
extension- annotates in which extension the code will be executed. The default value is an empty String which means the annotated code won't be executed!process- annotates in which process the code will be executed. DuringINIT,UPDATEor in both(ALL). If at a method annotation noprocessattribute is defined (or NOTDEFINED is used) the definition from the class annotation is used.type- annotates in which mode the code will be executed. During creation of essencial data(ESSENTIAL), during creation of project data(PROJECT)or in both modes(ALL). If at a method annotation notypeattribute is defined (or NOTDEFINED is used) the definition from the class annotation is used.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumDescribes, when the method should be called.static enumDescribes, at which point the method should be called. -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionDescription of a patch.The default value for parameterextensionis an empty String.Name of a patch.booleanMarks currentSystemSetupas a patch so the logic inside will be executed only once and tracked asSystemSetupAuditModelitem.The default value parameterprocessis ALL.booleanIndicates whether patch is required to apply or not.The default value for parametertypeis ALL. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThis constant can be used to tell the collector that the method should be called for every extension!
-
Field Details
-
ALL_EXTENSIONS
This constant can be used to tell the collector that the method should be called for every extension!- See Also:
-
-
Element Details
-
extension
String extensionThe default value for parameterextensionis an empty String.- Default:
- ""
-
type
SystemSetup.Type typeThe default value for parametertypeis ALL.- Default:
- NOTDEFINED
-
process
SystemSetup.Process processThe default value parameterprocessis ALL.- Default:
- NOTDEFINED
-
name
String nameName of a patch. Used only ifpatch()is used. Default is an empty String.- Default:
- ""
-
description
String descriptionDescription of a patch. Used only ifpatch()is used. Default is an empty String.- Default:
- ""
-
required
boolean requiredIndicates whether patch is required to apply or not. Used only ifpatch()is used. Default is an empty String.- Default:
- false
-
patch
boolean patchMarks currentSystemSetupas a patch so the logic inside will be executed only once and tracked asSystemSetupAuditModelitem.- Default:
- false
-