/*

  * #%L

  * CursorableMessage.java - mongodb-async-driver - Allanbank Consulting, Inc.

  * %%

  * Copyright (C) 2011 - 2014 Allanbank Consulting, Inc.

  * %%

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  * 

  *      http://www.apache.org/licenses/LICENSE-2.0

  * 

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  * #L%

  */

 package com.allanbank.mongodb.client.message;

 import com.allanbank.mongodb.client.Message;

 /**

  * CursorableMessage provides a common interface for messages that can start a

  * cursor.

  * 

  * @api.no This class is <b>NOT</b> part of the drivers API. This class may be

  *         mutated in incompatible ways between any two releases of the driver.

  * @copyright 2013, Allanbank Consulting, Inc., All Rights Reserved

  */

 public interface CursorableMessage extends Message {

     /**

      * Returns the number of documents to be returned in each batch of results.

      * 

      * @return The number of documents to be returned in each batch of results.

      */

     public int getBatchSize();

     /**

      * Returns the name of the collection.

      * 

      * @return The name of the collection.

      */

     public String getCollectionName();

     /**

      * Returns the total number of documents to be returned.

      * 

      * @return The total number of documents to be returned.

      */

     public int getLimit();

 }