/*
* Copyright 2023 Anyware Services
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The workflow transition DAO
*/
Ext.define('Ametys.plugins.workflow.dao.WorkflowTransitionDAO', {
singleton: true,
constructor: function()
{
/**
* @callable
* @member Ametys.plugins.workflow.dao.WorkflowTransitionDAO
* @method createTransition
* Create workflow transition
* This calls the method 'createTransition' of the server DAO 'WorkflowTransitionDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables(
{
role: "org.ametys.plugins.workflow.dao.WorkflowTransitionDAO",
methodName: "createTransition",
callback: {
handler: this._createTransitionCB
},
waitMessage: false,
errorMessage: {
msg: "{{i18n PLUGINS_WORKFLOW_TRANSITION_DAO_ERROR_TITLE}}",
category: Ext.getClassName(this)
}
}
);
/**
* @callable
* @member Ametys.plugins.workflow.dao.WorkflowTransitionDAO
* @method editTransitionLabel
* Rename a workflow transition
* This calls the method 'editTransitionLabel' of the server DAO 'WorkflowTransitionDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables(
{
role: "org.ametys.plugins.workflow.dao.WorkflowTransitionDAO",
methodName: "editTransitionLabel",
callback: {
handler: this._editTransitionLabelCB
},
waitMessage: false,
errorMessage: {
msg: "{{i18n PLUGINS_WORKFLOW_TRANSITION_DAO_ERROR_TITLE}}",
category: Ext.getClassName(this)
}
}
);
/**
* @callable
* @member Ametys.plugins.workflow.dao.WorkflowTransitionDAO
* @method editTransition
* Edit a workflow transition
* This calls the method 'editTransition' of the server DAO 'WorkflowTransitionDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables(
{
role: "org.ametys.plugins.workflow.dao.WorkflowTransitionDAO",
methodName: "editTransition",
callback: {
handler: this._editTransitionCB
},
waitMessage: false,
errorMessage: {
msg: "{{i18n PLUGINS_WORKFLOW_TRANSITION_DAO_ERROR_TITLE}}",
category: Ext.getClassName(this)
}
}
);
/**
* @callable
* @member Ametys.plugins.workflow.dao.WorkflowTransitionDAO
* @method addTransitions
* Add one or more workflow transitions
* This calls the method 'addTransitions' of the server DAO 'WorkflowTransitionDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables(
{
role: "org.ametys.plugins.workflow.dao.WorkflowTransitionDAO",
methodName: "addTransitions",
callback: {
handler: this._addTransitionsCB
},
waitMessage: false,
errorMessage: {
msg: "{{i18n PLUGINS_WORKFLOW_TRANSITION_DAO_ERROR_TITLE}}",
category: Ext.getClassName(this)
}
}
);
/**
* @callable
* @member Ametys.plugins.workflow.dao.WorkflowTransitionDAO
* @method removeTransition
* Remove the transition from selected step
* This calls the method 'removeTransition' of the server DAO 'WorkflowTransitionDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables(
{
role: "org.ametys.plugins.workflow.dao.WorkflowTransitionDAO",
methodName: "removeTransition",
callback: {
handler: this._removeTransitionCB
},
waitMessage: false,
errorMessage: {
msg: "{{i18n PLUGINS_WORKFLOW_TRANSITION_DAO_ERROR_TITLE}}",
category: Ext.getClassName(this)
}
}
);
/**
* @callable
* @member Ametys.plugins.workflow.dao.WorkflowTransitionDAO
* @method getNumberOfUse
* Get the number of use for this transition
* This calls the method 'getNumberOfUse' of the server DAO 'WorkflowTransitionDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables(
{
role: "org.ametys.plugins.workflow.dao.WorkflowTransitionDAO",
methodName: "getNumberOfUse",
callback: {
handler: Ext.emptyFn
},
waitMessage: false,
errorMessage: {
msg: "{{i18n PLUGINS_WORKFLOW_TRANSITION_DAO_ERROR_TITLE}}",
category: Ext.getClassName(this)
}
}
);
/**
* @callable
* @member Ametys.plugins.workflow.dao.WorkflowTransitionDAO
* @method getTransitionInfos
* Get values to initialize transition
* This calls the method 'getTransitionInfos' of the server DAO 'WorkflowTransitionDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables(
{
role: "org.ametys.plugins.workflow.dao.WorkflowTransitionDAO",
methodName: "getTransitionInfos",
callback: {
handler: Ext.emptyFn
},
waitMessage: false,
errorMessage: {
msg: "{{i18n PLUGINS_WORKFLOW_TRANSITION_DAO_ERROR_TITLE}}",
category: Ext.getClassName(this)
}
}
);
/**
* @callable
* @member Ametys.plugins.workflow.dao.WorkflowTransitionDAO
* @method getAvailableActions
* Get the list of available actions for current step
* This calls the method 'getAvailableActions' of the server DAO 'WorkflowTransitionDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables(
{
role: "org.ametys.plugins.workflow.dao.WorkflowTransitionDAO",
methodName: "getAvailableActions",
callback: {
handler: Ext.emptyFn
},
waitMessage: false,
errorMessage: {
msg: "{{i18n PLUGINS_WORKFLOW_TRANSITION_DAO_ERROR_TITLE}}",
category: Ext.getClassName(this)
}
}
);
},
/**
* Callback function called after {@link #createTransition} has been processed.
* @param {Object} response The text response provided by the {@link Ametys.data.ServerComm}
* @private
*/
_createTransitionCB: function(response)
{
if (response.message == 'duplicate-id')
{
Ametys.Msg.show({
title: "{{i18n PLUGINS_WORKFLOW_CREATE_ERROR_TITLE}}",
msg: "{{i18n PLUGINS_WORKFLOW_DUPLICATE_ID_MSG}}",
buttons: Ext.Msg.OK,
icon: Ext.Msg.ERROR
});
}
else
{
var workflowTarget = this._getWorkflowTarget(response);
var stepTarget = this._getStepTarget(response);
stepTarget.subtargets = this._getActionTarget(response);
workflowTarget.subtargets = stepTarget;
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.CREATED,
targets: [workflowTarget]
});
}
},
/**
* Callback function called after {@link #editTransition} has been processed.
* @param {Object} response The text response provided by the {@link Ametys.data.ServerComm}
* @private
*/
_editTransitionCB: function(response)
{
if (response.message == 'duplicate-id')
{
Ametys.Msg.show({
title: "{{i18n PLUGINS_WORKFLOW_EDIT_ERROR_TITLE}}",
msg: "{{i18n PLUGINS_WORKFLOW_DUPLICATE_ID_MSG}}",
buttons: Ext.Msg.OK,
icon: Ext.Msg.ERROR
});
}
else
{
var workflowTarget = this._getWorkflowTarget(response);
var stepTarget = this._getStepTarget(response);
stepTarget.subtargets = this._getActionTarget(response);
workflowTarget.subtargets = stepTarget;
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.MODIFIED,
targets: [workflowTarget]
});
}
},
/**
* Callback function called after {@link #editTransitionLabel} has been processed.
* @param {Object} response The text response provided by the {@link Ametys.data.ServerComm}
* @private
*/
_editTransitionLabelCB: function(response)
{
var workflowTarget = this._getWorkflowTarget(response);
var stepTarget = this._getStepTarget(response);
stepTarget.subtargets = this._getActionTarget(response);
workflowTarget.subtargets = stepTarget;
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.MODIFIED,
targets: [workflowTarget]
});
},
/**
* Callback function called after {@link #addTransitions} has been processed.
* @param {Object} response The text response provided by the {@link Ametys.data.ServerComm}
* @private
*/
_addTransitionsCB: function(response)
{
if (response.message == "initial-step")
{
Ametys.Msg.show({
title: "{{i18n PLUGINS_WORKFLOW_ADD_ERROR_TITLE}}",
msg: "{{i18n PLUGINS_WORKFLOW_INITIAL_STEP_MSG}}",
buttons: Ext.Msg.OK,
icon: Ext.Msg.ERROR
});
}
else
{
var workflowTarget = this._getWorkflowTarget(response);
var stepTarget = this._getStepTarget(response);
workflowTarget.subtargets = stepTarget;
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.MODIFIED,
targets: [workflowTarget]
});
}
},
/**
* Callback function called after {@link #removeTransition} has been processed.
* @param {Object} response The text response provided by the {@link Ametys.data.ServerComm}
* @private
*/
_removeTransitionCB: function(response)
{
var workflowTarget = this._getWorkflowTarget(response);
var stepTarget = this._getStepTarget(response);
workflowTarget.subtargets = stepTarget;
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.MODIFIED,
targets: [workflowTarget]
});
},
/**
* @private
* Get the workflow target
* @param {Object} response the serveur response
* @param {String} response.workflowId the name of current workflow
*/
_getWorkflowTarget: function(response)
{
return {
id: Ametys.message.MessageTarget.WORKFLOW_OBJECT,
parameters: {
id: response.workflowId
}
}
},
/**
* @private
* Get the step target
* @param {Object} response the serveur response
* @param {String} response.workflowId the name of current workflow
* @param {String} response.stepId the id of the step
* @param {String} response.stepLabel the label of the step
*/
_getStepTarget: function(response)
{
return {
id: Ametys.message.MessageTarget.WORKFLOW_STEP,
parameters: {
id: response.stepId,
label: response.stepLabel,
workflowId: response.workflowId
}
};
},
/**
* @private
* Get the action target
* @param {Object} response the serveur response
* @param {String} response.workflowId the name of current workflow
* @param {String} response.stepId the id of the parent step
* @param {String} response.actionId the id of the action
* @param {String} response.actionLabels the labels of the action
*/
_getActionTarget: function(response)
{
return {
id: Ametys.message.MessageTarget.WORKFLOW_ACTION,
parameters: {
id: response.actionId,
label: response.actionLabels,
stepId: response.stepId,
workflowId: response.workflowId
}
};
}
});