1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.model.message;
21
22
23 /**
24 * Abandon protocol operation request to terminate an operation already in
25 * progress.
26 *
27 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
28 */
29 public interface AbandonRequest extends Request
30 {
31 /** Ldap abandon request type code */
32 MessageTypeEnum TYPE = MessageTypeEnum.ABANDON_REQUEST;
33
34
35 /**
36 * Gets the id of the request operation to terminate.
37 *
38 * @return the id of the request message to abandon
39 */
40 int getAbandoned();
41
42
43 /**
44 * Sets the id of the request operation to terminate.
45 *
46 * @param requestId the sequence id of the request message to abandon
47 * @return The AbandonRequest instance
48 */
49 AbandonRequest setAbandoned( int requestId );
50 }