com.allanbank.mongodb.client.message

Interface CursorableMessage

All Superinterfaces:

Message

All Known Implementing Classes:

AggregateCommand, GetLastError, ParallelScanCommand, Query

public interface CursorableMessage
extends Message

CursorableMessage provides a common interface for messages that can start a cursor.

API Warning:

This class is NOT 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

Method Summary

Methods

Modifier and Type	Method and Description
int	getBatchSize() Returns the number of documents to be returned in each batch of results.
String	getCollectionName() Returns the name of the collection.
int	getLimit() Returns the total number of documents to be returned.

Methods inherited from interface com.allanbank.mongodb.client.Message

getDatabaseName, getOperationName, getReadPreference, getRequiredVersionRange, size, validateSize, write, write

Method Detail

getBatchSize

int getBatchSize()

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

Returns:

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

getCollectionName

String getCollectionName()

Returns the name of the collection.

Returns:

The name of the collection.

getLimit

int getLimit()

Returns the total number of documents to be returned.

Returns:

The total number of documents to be returned.