fc-plugin-codbi/com.github.xima_formcycle_entwicklerkreis.fc.plugin.codbi.logic.LocalAPIDoc/StructuredDataStoreAction

StructuredDataStoreAction

class StructuredDataStoreAction : IPluginServletAction

A servlet action plugin that provides an endpoint for storing and retrieving structured JSON data. Data is persisted to the database via CodbiEntities.

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
open override fun execute(params: IPluginServletActionParams): IPluginServletActionRetVal

Retrieves or updates the API-Documentation depending on the provided "X-Action" set within the params headerMap (either "Retrieve" or "Update"). An "Update" overwrites existing data.

Link copied to clipboard
open fun getDescription(): String
open fun getDescription(p0: Locale): String
Link copied to clipboard
open override fun getDisplayName(p0: Locale): String
Link copied to clipboard
open override fun getName(): String

The name of this plugin servlet action.

Link copied to clipboard
open override fun initialize(configData: IPluginInitializeData)

Initializes the plugin by loading configuration.

Link copied to clipboard
open fun initPlugin()
Link copied to clipboard
open fun install(p0: IPluginInstallData)
Link copied to clipboard
open fun shutdown()
open fun shutdown(p0: IPluginShutdownData)
Link copied to clipboard
open fun uninstall(p0: IPluginUninstallData)
Link copied to clipboard
open override fun validateConfigurationData(configData: IPluginValidationData): IPluginInitializeValidationResult?

Configuration validation