001/*
002 *  Copyright 2023 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.cms.workflow;
017
018import java.util.Map;
019
020import org.ametys.cms.repository.ModifiableWorkflowAwareContent;
021import org.ametys.cms.repository.WorkflowAwareContent;
022import org.ametys.runtime.i18n.I18nizableText;
023
024import com.opensymphony.module.propertyset.PropertySet;
025import com.opensymphony.workflow.WorkflowException;
026
027/**
028 * Function to notify the event given in the transient vars if exist
029 */
030public class NotifyFunction extends AbstractContentFunction
031{
032    public void execute(Map transientVars, Map args, PropertySet ps) throws WorkflowException
033    {
034        WorkflowAwareContent content = getContent(transientVars);
035        
036        if (!(content instanceof ModifiableWorkflowAwareContent))
037        {
038            throw new IllegalArgumentException("The provided content " + content.getId() + " is not a ModifiableWorkflowAwareContent.");
039        }
040        
041        _notify(content, transientVars);
042    }
043    
044    @Override
045    protected String _getDefaultEvent()
046    {
047        return null;
048    }
049    
050    public I18nizableText getLabel()
051    {
052        return new I18nizableText("plugin.cms", "PLUGINS_CMS_NOTIFY_FUNCTION_LABEL");
053    }
054}