Package org.cyclos.model.system.scripts
Enum ScriptType
- java.lang.Object
-
- java.lang.Enum<ScriptType>
-
- org.cyclos.model.system.scripts.ScriptType
-
- All Implemented Interfaces:
Serializable,Comparable<ScriptType>,HasMessageKey
public enum ScriptType extends Enum<ScriptType> implements HasMessageKey
Contains the possible types for a custom script
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACCOUNT_FEE_CALCULATIONCalculates the charged amount of an account feeACCOUNT_NUMBER_GENERATIONGenerates numbers for accountsBACKGROUND_TASKCustom background tasks that run in a single-shotCONTENT_HELPERGenerates variables useable in dynamic content with ThymeleafCUSTOM_FIELD_VALIDATIONValidation a custom field valueCUSTOM_OPERATIONExecution of custom operationsCUSTOM_WEB_SERVICEExecution of custom web servicesCUSTOM_WIZARDExecution of custom wizardsEXPORT_FORMATGenerate the content of a file exportEXTENSION_POINTExtension points are callbacks invoked during events such as creating users, performing payments, ...INBOUND_SMSReads an incoming request to be interpreted as an inbound SMSIP_GEOLOCATIONGeo-locates an IP addressLIBRARYA library which can be included by other scriptsLINK_GENERATIONCustom link generation, for example, a custom front-end could receive user linksLOAD_CUSTOM_FIELD_VALUESGenerates possible values for a custom fieldNOTIFICATIONGenerate the content of a notification (internal, email, sms, Firebase (FCM)OUTBOUND_SMSSMS sendingPASSWORD_HANDLINGChecks whether passwords are correctPHONE_NUMBER_HANDLINGHandles phone numbersSCHEDULED_TASKCustom scheduled tasks that run periodicallySERVICE_INTERCEPTORA script executed before / after a service operation is executedSESSION_HANDLINGCustom handling of sessions (for connected users)SMS_OPERATIONExecution of a custom operation via inbound SMSTRANSFER_FEE_CALCULATIONCalculates the charged amount of a transfer feeTRANSFER_STATUSDetermines the possible transitions between transfer statuses
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanallowAuthenticationCustomization()Class<? extends ScriptFunction>getFunctionClass()Returns the function class that this script type handlesMessageKeygetMessageKey()booleanmustRunAsSystem()static ScriptTypevalueOf(String name)Returns the enum constant of this type with the specified name.static ScriptType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LIBRARY
public static final ScriptType LIBRARY
A library which can be included by other scripts
-
CUSTOM_FIELD_VALIDATION
public static final ScriptType CUSTOM_FIELD_VALIDATION
Validation a custom field value
-
LOAD_CUSTOM_FIELD_VALUES
public static final ScriptType LOAD_CUSTOM_FIELD_VALUES
Generates possible values for a custom field
-
ACCOUNT_NUMBER_GENERATION
public static final ScriptType ACCOUNT_NUMBER_GENERATION
Generates numbers for accounts
-
ACCOUNT_FEE_CALCULATION
public static final ScriptType ACCOUNT_FEE_CALCULATION
Calculates the charged amount of an account fee
-
TRANSFER_FEE_CALCULATION
public static final ScriptType TRANSFER_FEE_CALCULATION
Calculates the charged amount of a transfer fee
-
TRANSFER_STATUS
public static final ScriptType TRANSFER_STATUS
Determines the possible transitions between transfer statuses
-
SESSION_HANDLING
public static final ScriptType SESSION_HANDLING
Custom handling of sessions (for connected users)
-
PASSWORD_HANDLING
public static final ScriptType PASSWORD_HANDLING
Checks whether passwords are correct
-
PHONE_NUMBER_HANDLING
public static final ScriptType PHONE_NUMBER_HANDLING
Handles phone numbers
-
EXTENSION_POINT
public static final ScriptType EXTENSION_POINT
Extension points are callbacks invoked during events such as creating users, performing payments, ...
-
CUSTOM_OPERATION
public static final ScriptType CUSTOM_OPERATION
Execution of custom operations
-
CUSTOM_WIZARD
public static final ScriptType CUSTOM_WIZARD
Execution of custom wizards
-
CUSTOM_WEB_SERVICE
public static final ScriptType CUSTOM_WEB_SERVICE
Execution of custom web services
-
SERVICE_INTERCEPTOR
public static final ScriptType SERVICE_INTERCEPTOR
A script executed before / after a service operation is executed
-
SCHEDULED_TASK
public static final ScriptType SCHEDULED_TASK
Custom scheduled tasks that run periodically
-
BACKGROUND_TASK
public static final ScriptType BACKGROUND_TASK
Custom background tasks that run in a single-shot
-
SMS_OPERATION
public static final ScriptType SMS_OPERATION
Execution of a custom operation via inbound SMS
-
INBOUND_SMS
public static final ScriptType INBOUND_SMS
Reads an incoming request to be interpreted as an inbound SMS
-
OUTBOUND_SMS
public static final ScriptType OUTBOUND_SMS
SMS sending
-
LINK_GENERATION
public static final ScriptType LINK_GENERATION
Custom link generation, for example, a custom front-end could receive user links
-
EXPORT_FORMAT
public static final ScriptType EXPORT_FORMAT
Generate the content of a file export
-
NOTIFICATION
public static final ScriptType NOTIFICATION
Generate the content of a notification (internal, email, sms, Firebase (FCM)
-
CONTENT_HELPER
public static final ScriptType CONTENT_HELPER
Generates variables useable in dynamic content with Thymeleaf
-
IP_GEOLOCATION
public static final ScriptType IP_GEOLOCATION
Geo-locates an IP address
-
-
Method Detail
-
values
public static ScriptType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ScriptType c : ScriptType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ScriptType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
allowAuthenticationCustomization
public boolean allowAuthenticationCustomization()
-
getFunctionClass
public Class<? extends ScriptFunction> getFunctionClass()
Returns the function class that this script type handles
-
getMessageKey
public MessageKey getMessageKey()
- Specified by:
getMessageKeyin interfaceHasMessageKey
-
mustRunAsSystem
public boolean mustRunAsSystem()
-
-