1 /*
2 * #%L
3 * CursorableMessage.java - mongodb-async-driver - Allanbank Consulting, Inc.
4 * %%
5 * Copyright (C) 2011 - 2014 Allanbank Consulting, Inc.
6 * %%
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * #L%
19 */
20 package com.allanbank.mongodb.client.message;
21
22 import com.allanbank.mongodb.client.Message;
23
24 /**
25 * CursorableMessage provides a common interface for messages that can start a
26 * cursor.
27 *
28 * @api.no This class is <b>NOT</b> part of the drivers API. This class may be
29 * mutated in incompatible ways between any two releases of the driver.
30 * @copyright 2013, Allanbank Consulting, Inc., All Rights Reserved
31 */
32 public interface CursorableMessage extends Message {
33 /**
34 * Returns the number of documents to be returned in each batch of results.
35 *
36 * @return The number of documents to be returned in each batch of results.
37 */
38 public int getBatchSize();
39
40 /**
41 * Returns the name of the collection.
42 *
43 * @return The name of the collection.
44 */
45 public String getCollectionName();
46
47 /**
48 * Returns the total number of documents to be returned.
49 *
50 * @return The total number of documents to be returned.
51 */
52 public int getLimit();
53
54 }