StoreAction.java

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is part of dcm4che, an implementation of DICOM(TM) in
 * Java(TM), hosted at https://github.com/gunterze/dcm4che.
 *
 * The Initial Developer of the Original Code is
 * Agfa Healthcare.
 * Portions created by the Initial Developer are Copyright (C) 2011-2014
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * See @authors listed below
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

package org.dcm4chee.archive.conf;

/**
 * There Store Action determines how a store operation of a single instance will be handled, especially in the case that
 * the instance already exists.
 *
 * @author Gunter Zeilinger <gunterze@gmail.com>
 * @author Hermann Czedik-Eysenberg <hermann-agfa@czedik.net>
 */
public enum StoreAction {

    /**
     * Normal store. The instance doesn't exist yet.
     */
    STORE,

    /**
     * The instance should be stored again. This typically happens all (local) locations of an instance were deleted
     * previously and it's now getting sent in again.
     */
    RESTORE,

    /**
     * The instance is already existing, but should be completely replaced. This involves deleting all old
     * locations and the old instance record from the database and storing the new instance.
     */
    REPLACE,

    /**
     * The instance already exists and the newly stored version should be completely ignored.
     */
    IGNORE,

    /**
     * The instance already exists and will not be stored again, only the database will be updated.
     */
    UPDATEDB,

    /**
     * Some problem happened during storage or during updating the database and the store operation for this instance
     * should fail (i.e. should be completely rolled back).
     */
    FAIL
}