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-2014 UnboundID Corp. 026 */ 027 package com.unboundid.directory.sdk.common.operation; 028 029 030 031 import java.util.List; 032 033 import com.unboundid.ldap.sdk.Control; 034 import com.unboundid.util.NotExtensible; 035 import com.unboundid.util.ThreadSafety; 036 import com.unboundid.util.ThreadSafetyLevel; 037 038 039 040 /** 041 * This interface defines a set of methods which may be used to update the 042 * contents of operation results. 043 */ 044 @NotExtensible() 045 @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 046 public interface UpdatableResult 047 extends Result 048 { 049 /** 050 * Updates the set of result controls for this result. 051 * 052 * @param controls The set of controls to use for this result. It may be 053 * {@code null} or empty if there should not be any 054 * controls. 055 */ 056 void setResultControls(final List<Control> controls); 057 058 059 060 /** 061 * Adds the provided control to the set of result controls for this result. 062 * 063 * @param control The control to be added to the set of result controls for 064 * this result. It must not be {@code null}. 065 */ 066 void addResultControl(final Control control); 067 }