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 com.unboundid.asn1.ASN1OctetString; 032 import com.unboundid.ldap.sdk.LDAPResult; 033 import com.unboundid.util.NotExtensible; 034 import com.unboundid.util.ThreadSafety; 035 import com.unboundid.util.ThreadSafetyLevel; 036 037 038 039 /** 040 * This interface defines a set of methods which may be used to update extended 041 * results. 042 */ 043 @NotExtensible() 044 @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 045 public interface UpdatableExtendedResult 046 extends ExtendedResult, UpdatableGenericResult 047 { 048 /** 049 * Specifies the OID for the extended result, if any. 050 * 051 * @param oid The OID for the extended result. It may be {@code null} if 052 * there is none. 053 */ 054 void setResultOID(final String oid); 055 056 057 058 /** 059 * Specifies the value for the extended result, if any. 060 * 061 * @param value The value for the extended result. It may be {@code null} 062 * if there is none. 063 */ 064 void setResultValue(final ASN1OctetString value); 065 066 067 068 /** 069 * Sets the contents of this result with information from the provided 070 * LDAP result, including the result code, diagnostic message, matched DN, 071 * referral URLs, and controls. If the provided result is also an instance 072 * of an LDAP SDK {@code ExtendedResult}, then the response OID and value will 073 * also be updated. 074 * 075 * @param result The result to use to update this result. It must not be 076 * {@code null}. 077 */ 078 void setResultData(final LDAPResult result); 079 }