/*
* Copyright 2021 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 client-side for org.ametys.cms.search.schedule.Export Scheduler component.
*/
Ext.define('Ametys.plugins.cms.search.AsyncExportScheduler', {
singleton: true,
constructor: function(config)
{
/**
* @callable
* @member Ametys.plugins.core.schedule.Scheduler
* @method add
* Adds a new task to export solr search.
* This calls the method 'add' of the server DAO 'ExportScheduler'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {String} parameters.label The label
* @param {String} parameters.description The description
* @param {String} parameters.runAtStartup true to run the task once, when the server will restart
* @param {String} parameters.cron The cron expression
* @param {String} parameters.launchUser The user used to launch the task
* @param {Object} parameters.params The values of the parameters
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.returnedValue The value return from the server. Null on error (please note that when an error occured, the callback may not be called depending on the value of errorMessage).
* @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.cms.search.solr.AsyncExportLauncher",
methodName: "add",
callback: {
handler: this._addCb
},
errorMessage: {
msg: "{{i18n plugin.core:PLUGINS_CORE_SCHEDULER_ERROR_MESSAGE}}",
category:Ext.getClassName(this)
}
}
);
},
/**
* @private
* Callback function called after {@link #add} has been processed.
* @param {Object} response The server response
*/
_addCb: function(response)
{
var error = response['error'] || '';
var id = response['id'];
if (error == "invalid-schedulable")
{
Ametys.Msg.show({
title: "{{i18n plugin.core:PLUGINS_CORE_SCHEDULER_ERROR_INVALID_SCHEDULABLE_ID_TITLE}}",
msg: "{{i18n plugin.core:PLUGINS_CORE_SCHEDULER_ERROR_INVALID_SCHEDULABLE_ID}}",
buttons: Ext.Msg.OK,
icon: Ext.MessageBox.ERROR
});
}
else if (error || !id)
{
Ametys.Msg.show({
title: "{{i18n plugin.core:PLUGINS_CORE_SCHEDULER_ERROR_SCHEDULER_TITLE}}",
msg: "{{i18n plugin.core:PLUGINS_CORE_SCHEDULER_ERROR_SCHEDULER}}",
buttons: Ext.Msg.OK,
icon: Ext.MessageBox.ERROR
});
}
else
{
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.CREATED,
targets: [{
id: Ametys.message.MessageTarget.TASK,
parameters: {
id: id
}
}]
});
}
}
});