com.iplanet.jato.model
Interface DatasetModelExecutionContext

All Superinterfaces:
ModelExecutionContext
All Known Implementing Classes:
DatasetModelExecutionContextImpl

public interface DatasetModelExecutionContext
extends ModelExecutionContext

Specialized execution context used for execution of dataset model operations. This context is normally only used with retrieve operations. The methods in this interface define a dataset "window" which, after model execution, should comprise the entire available datasets of the executed model.

Version:
JATO/1.2.2 $Id: DatasetModelExecutionContext.java,v 1.6 2002/03/16 03:26:30 todd Exp $

Field Summary
static int DATASET_OFFSET_BEGINNING
          Fetch the dataset from the beginning of the available data
static int DATASET_OFFSET_END
          Fetch the dataset from the end of the available data
static int DATASET_SIZE_ALL_INCREMENTAL
          Fetch individual sets of data as needed.
static int DATASET_SIZE_ALL_PREFETCH
          Fetch the entire dataset at once
 
Fields inherited from interface com.iplanet.jato.model.ModelExecutionContext
OPERATION_DELETE, OPERATION_EXECUTE, OPERATION_INSERT, OPERATION_RETRIEVE, OPERATION_UPDATE
 
Method Summary
 int getDatasetOffset()
          Return the base offset from an implementation- or context-dependent reference location that should used when retrieving a dataset.
 int getDatasetSize()
          Return the total size of the dataset that should be fetched when retrieving data.
 
Methods inherited from interface com.iplanet.jato.model.ModelExecutionContext
getOperationName
 

Field Detail

DATASET_OFFSET_BEGINNING

public static final int DATASET_OFFSET_BEGINNING
Fetch the dataset from the beginning of the available data

DATASET_OFFSET_END

public static final int DATASET_OFFSET_END
Fetch the dataset from the end of the available data

DATASET_SIZE_ALL_PREFETCH

public static final int DATASET_SIZE_ALL_PREFETCH
Fetch the entire dataset at once

DATASET_SIZE_ALL_INCREMENTAL

public static final int DATASET_SIZE_ALL_INCREMENTAL
Fetch individual sets of data as needed. Use this size directive
Method Detail

getDatasetOffset

public int getDatasetOffset()
Return the base offset from an implementation- or context-dependent reference location that should used when retrieving a dataset. Normally, after execution of a model with a positive offset, the DatasetModelControl.first() should be positioned at the location defined by the offset.
Returns:
The implementation- or context-dependent offset location, or one of the special offset directives. There may be some significant restrictions on use of these size directives depending on the model implementation.

getDatasetSize

public int getDatasetSize()
Return the total size of the dataset that should be fetched when retrieving data. For example, this method might specify the number of rows to retrieve from a SQL query.
Returns:
The total dataset size, or one of the special size directives. If a non-special size value (a positive number) is specified here, the executing model operates in prefetch mode. If incremental fetch is specified, then the dataset size is not fixed or necessarily known. There may be some significant restrictions on use of these size directives depending on the model implementation.