001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
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 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.ecm.automation.core;
020
021import java.util.ArrayList;
022import java.util.List;
023
024import org.nuxeo.common.xmap.annotation.XNode;
025import org.nuxeo.common.xmap.annotation.XNodeList;
026import org.nuxeo.common.xmap.annotation.XObject;
027import org.nuxeo.ecm.automation.core.annotations.Operation;
028import org.nuxeo.ecm.platform.forms.layout.descriptors.WidgetDescriptor;
029
030/**
031 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
032 * @author <a href="mailto:[email protected]">Guillaume Renard</a>
033 */
034@XObject("operation")
035public class OperationContribution {
036
037    /**
038     * The operation class that must be annotated using {@link Operation} annotation.
039     */
040    @XNode("@class")
041    public Class<?> type;
042
043    /**
044     * Put it to true to override an existing contribution having the same ID. By default overriding is not permitted
045     * and an exception is thrown when this flag is on false.
046     */
047    @XNode("@replace")
048    public boolean replace;
049
050    /**
051     * The widget descriptor for the operation parameters.
052     *
053     * @since 5.9.5
054     */
055    @XNodeList(componentType = WidgetDescriptor.class, type = ArrayList.class, value = "widgets/widget")
056    public List<WidgetDescriptor> widgets;
057
058}