001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 * Portions Copyright 2015 ForgeRock AS.
016 */
017
018package org.opends.server.types;
019
020/**
021 * Base for data structures that define configuration
022 * for operations.
023 */
024@org.opends.server.types.PublicAPI(
025     stability=org.opends.server.types.StabilityLevel.VOLATILE,
026     mayInstantiate=true,
027     mayExtend=false,
028     mayInvoke=true)
029public abstract class OperationConfig {
030
031  /**
032   * When true indicates that the operation should stop as soon as
033   * possible.
034   */
035  private boolean cancelled;
036
037  /**
038   * Indicates that this operation has been cancelled and the
039   * operation if executing should finish as soon as possible.
040   */
041  public void cancel()
042  {
043    this.cancelled = true;
044  }
045
046  /**
047   * Indicates whether or not this operation has been
048   * cancelled.
049   *
050   * @return boolean where true indicates that this
051   *         operation has been cancelled and if currently
052   *         executing will finish as soon as possible
053   */
054  public boolean isCancelled()
055  {
056    return this.cancelled;
057  }
058}