001/*
002 * (C) Copyright 2012 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Thomas Roger (troger@nuxeo.com)
016 */
017
018package org.nuxeo.ecm.activity;
019
020import org.nuxeo.common.xmap.annotation.XNode;
021import org.nuxeo.common.xmap.annotation.XObject;
022import org.nuxeo.ecm.core.api.NuxeoException;
023
024/**
025 * Descriptor object for registering {@link org.nuxeo.ecm.activity.ActivityUpgrader}s.
026 *
027 * @author <a href="mailto:troger@nuxeo.com">Thomas Roger</a>
028 * @since 5.7
029 */
030@XObject("activityUpgrader")
031public class ActivityUpgraderDescriptor {
032
033    @XNode("@enabled")
034    protected boolean enabled = true;
035
036    @XNode("@name")
037    protected String name;
038
039    @XNode("@order")
040    protected int order = 0;
041
042    @XNode("@class")
043    protected Class<? extends ActivityUpgrader> activityUpgraderClass;
044
045    public String getName() {
046        return name;
047    }
048
049    public void setName(String name) {
050        this.name = name;
051    }
052
053    public int getOrder() {
054        return order;
055    }
056
057    public void setOrder(int order) {
058        this.order = order;
059    }
060
061    public ActivityUpgrader getActivityUpgrader() {
062        try {
063            ActivityUpgrader upgrader = activityUpgraderClass.newInstance();
064            upgrader.setName(name);
065            upgrader.setOrder(order);
066            return upgrader;
067        } catch (ReflectiveOperationException e) {
068            throw new NuxeoException(e);
069        }
070    }
071
072    public boolean isEnabled() {
073        return enabled;
074    }
075
076    public void setEnabled(boolean enabled) {
077        this.enabled = enabled;
078    }
079
080    public Class<? extends ActivityUpgrader> getActivityUpgraderClass() {
081        return activityUpgraderClass;
082    }
083
084    public void setActivityUpgraderClass(Class<? extends ActivityUpgrader> activityUpgraderClass) {
085        this.activityUpgraderClass = activityUpgraderClass;
086    }
087
088    @Override
089    public ActivityUpgraderDescriptor clone() {
090        ActivityUpgraderDescriptor clone = new ActivityUpgraderDescriptor();
091        clone.setName(name);
092        clone.setOrder(order);
093        clone.setActivityUpgraderClass(activityUpgraderClass);
094        clone.setEnabled(enabled);
095        return clone;
096    }
097
098}