Interface ICustomParametersUpdateable
-
- All Known Subinterfaces:
IBaseActionClientHandlerNode<TData>
,IBaseActionNode<TData>
,IBaseConditionClientHandlerNode<TData>
,IBaseTrigger<TData>
,IBeanValidatingElement<TData,TElement>
,IBeanValidatingNode<TData>
,IBeanValidatingTrigger<TData>
,IBuiltinNodeType<TData>
,IBuiltinResourcesHandler<TData,TElement>
,IBuiltinTriggerType<TData>
,IDefaultClientHandlerNode<TData>
,IDefaultClientHandlerTrigger<TData>
,IElementHandler<TData,TElement>
,IExecutingLikeActionNode<TData>
,IExecutingLikeBinarySelectionNode<TData>
,IExecutingLikeExceptionHandlerNode<TData>
,IExecutingLikeMultiSwitchNode<TData>
,IExecutingLikeReturningActionNode<TData>
,IExecutingLikeReturnNode<TData>
,IExecutingLikeSequenceNode<TData>
,IExecutingLikeThrowNode<TData>
,IFileProviding<TData>
,IHierarchyValidatingNode<TData>
,IKeyValueSummarizableElement<TData,TElement>
,IKeyValueSummarizableNode<TData>
,IKeyValueSummarizableTrigger<TData>
,INodeHandler<TData>
,IOfficialHelpPageElement<TData,TElement>
,IOfficialHelpPageNode<TData>
,IOfficialHelpPageTrigger<TData>
,IPluginActionNodeHandler<TData>
,IPluginConditionNodeHandler<TData>
,IPluginTriggerHandler<TData>
,IResultlessNode<TData>
,ISemverUpdating<TData,TElement>
,ISemverUpdatingNode<TData>
,ISemverUpdatingTrigger<TData>
,ISequentialUpdating<TData,TElement,TVersion>
,ISingleBaseActionBuiltinNodePrototype<TData>
,ISingleBaseActionNodePrototype<TData>
,ISingleBaseBuiltinTriggerPrototype<TData>
,ISingleBaseConditionNodePrototype<TData>
,ISingleBaseTriggerPrototype<TData>
,ISingleBuiltinNodePrototype<TData>
,ISingleBuiltinTriggerPrototype<TData>
,ISingleElementPrototype<TData,TElement>
,ISingleNodePrototype<TData>
,ISingleTriggerPrototype<TData>
,ISpecificTriggerListener<TData>
,ITriggerHandler<TData>
- All Known Implementing Classes:
APluginActionNodeHandler
,APluginConditionNodeHandler
,APluginTriggerHandler
,FcCatchErrorHandler
,FcChangeFormAvailabilityHandler
,FcChangeFormValueHandler
,FcChangeStateHandler
,FcCompressAsZipHandler
,FcCopyFormRecordHandler
,FcCounterHandler
,FcCreateTextFileHandler
,FcDecodeBase64Handler
,FcDeleteAttachmentHandler
,FcDeleteFormRecordHandler
,FcDoiInitHandler
,FcDoiVerifiedHandler
,FcEmailHandler
,FcEmptyHandler
,FcEncodeBase64Handler
,FcExperimentHandler
,FcExportToPersistenceHandler
,FcExportToXmlHandler
,FcFillPdfHandler
,FcFillWordHandler
,FcFormSubmitButtonHandler
,FcHttpRequestHandler
,FcImportFormValueFromXmlHandler
,FcInvitationErrorHandler
,FcInvitationSentHandler
,FcLdapQueryHandler
,FcLogEntryHandler
,FcManualHandler
,FcMoveFormRecordToInboxHandler
,FcMultipleConditionHandler
,FcProcessHistoryPdfHandler
,FcProcessLogPdfHandler
,FcProvideResourceHandler
,FcQualifiedFormSubmitButtonHandler
,FcQueueTaskHandler
,FcRedirectHandler
,FcRenewProcessIdHandler
,FcReturnFileHandler
,FcReturnHandler
,FcSaveToFileSystemHandler
,FcSaveToWebDavHandler
,FcSequenceHandler
,FcSetSavedFlagHandler
,FcShowTemplateHandler
,FcSqlStatementHandler
,FcStateTimerHandler
,FcSwitchCaseHandler
,FcSwitchDefaultHandler
,FcSwitchHandler
,FcThrowExceptionHandler
,FcTimePointHandler
,FcWriteFormRecordAttrHandler
public interface ICustomParametersUpdateable
Interface meant to be used along withICustomParametersProviding
for updating the custom parameters that were created with a previous version of the software product.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default com.alibaba.fastjson.JSONObject
updateCustomParams(IUpdateCustomParametersParams params)
Updates the custom parameters to the currentIVersionedCustomParametersProviding.getCustomParametersVersion()
.
-
-
-
Method Detail
-
updateCustomParams
default com.alibaba.fastjson.JSONObject updateCustomParams(IUpdateCustomParametersParams params)
Updates the custom parameters to the currentIVersionedCustomParametersProviding.getCustomParametersVersion()
.The properties are stored as JSON, and the version is stored along with it. Later (such as after the software was updated), when this JSON needs to be retrieved again, the version is compared against the current version. When the versions are not equal,
updateCustomParams(IUpdateCustomParametersParams)
is called on the raw JSON data, giving you a chance to update the properties before they are deserialized.Please note that the previous version is only guaranteed to be different from the current version. You must not assume the previous version is lower than the current one, e.g. when the software was downgraded. This is a low-level interface,
The default implementation simply assumes there are not changes and return the data that was passed in.
- Parameters:
params
- The JSON data to update, and the current and previous version.- Returns:
- The updated JSON data. You may mutate the given JSON, or create a fresh JSON object.
-
-