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;
020
021/**
022 * Throw it from an operation to interrupt a chain execution. The chain terminates silently (without throwing an
023 * exception) and the <code>output</code> object is returned as the chain output.
024 * <p>
025 * Also, you can set the <code>rollback</code> argument to true to rollback the current transaction.
026 *
027 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
028 */
029@SuppressWarnings("serial")
030public class ExitException extends OperationException {
031
032    private static final long serialVersionUID = 1L;
033    protected Object output;
034
035    public ExitException() {
036        this(null, false);
037    }
038
039    public ExitException(Object output) {
040        this(output, false);
041    }
042
043    public ExitException(Object output, boolean rollback) {
044        super("Chain Interrupted");
045        this.output = output;
046        this.rollback = rollback;
047    }
048
049    public ExitException setOutput(Object output) {
050        this.output = output;
051        return this;
052    }
053
054    public Object getOutput() {
055        return output;
056    }
057
058}