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 2006-2009 Sun Microsystems, Inc.
015 * Portions Copyright 2014-2015 ForgeRock AS.
016 */
017package org.opends.server.core;
018
019import org.opends.server.types.Operation;
020import org.forgerock.opendj.ldap.ByteString;
021
022
023/**
024 * This interface defines an extended operation, which can perform virtually any
025 * kind of task.
026 */
027public interface ExtendedOperation
028       extends Operation
029{
030  /**
031   * Retrieves the OID for the request associated with this extended
032   * operation.
033   *
034   * @return  The OID for the request associated with this extended
035   *          operation.
036   */
037  String getRequestOID();
038
039
040
041  /**
042   * Retrieves the value for the request associated with this extended
043   * operation.
044   *
045   * @return  The value for the request associated with this extended
046   *          operation.
047   */
048  ByteString getRequestValue();
049
050
051
052  /**
053   * Retrieves the OID to include in the response to the client.
054   *
055   * @return  The OID to include in the response to the client.
056   */
057  String getResponseOID();
058
059
060
061  /**
062   * Specifies the OID to include in the response to the client.
063   *
064   * @param  responseOID  The OID to include in the response to the
065   *                      client.
066   */
067  void setResponseOID(String responseOID);
068
069
070
071  /**
072   * Retrieves the value to include in the response to the client.
073   *
074   * @return  The value to include in the response to the client.
075   */
076  ByteString getResponseValue();
077
078
079
080  /**
081   * Specifies the value to include in the response to the client.
082   *
083   * @param  responseValue  The value to include in the response to
084   *                        the client.
085   */
086  void setResponseValue(ByteString responseValue);
087}
088