001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2010-2021 Ping Identity Corporation 026 */ 027package com.unboundid.directory.sdk.ds.types; 028 029 030 031import com.unboundid.util.ThreadSafety; 032import com.unboundid.util.ThreadSafetyLevel; 033 034 035 036/** 037 * This enum defines the states that a task may have after it has completed 038 * processing. 039 */ 040@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 041public enum TaskReturnState 042{ 043 /** 044 * Indicates that the task completed all of its processing without any errors. 045 */ 046 COMPLETED_SUCCESSFULLY, 047 048 049 050 /** 051 * Indicates that the task completed all of its processing but encountered one 052 * or more errors in the process. 053 */ 054 COMPLETED_WITH_ERRORS, 055 056 057 058 /** 059 * Indicates that the task was stopped prematurely because the server was 060 * shutting down. 061 */ 062 STOPPED_BY_SHUTDOWN, 063 064 065 066 /** 067 * Indicates that the task was stopped prematurely because an error occurred 068 * during processing that made it unable to continue. 069 */ 070 STOPPED_BY_ERROR, 071 072 073 074 /** 075 * Indicates that the task was stopped prematurely because it was canceled 076 * by an administrator. 077 */ 078 STOPPED_BY_ADMINISTRATOR; 079}