com.iplanet.jato.model.sql
Interface QueryModel

All Superinterfaces:
ExecutingModel, Model, SQLModel
All Known Subinterfaces:
DeleteQueryModel, InsertQueryModel, ModifyingQueryModel, SelectQueryModel, UpdateQueryModel
All Known Implementing Classes:
QueryModelBase

public interface QueryModel
extends SQLModel

Defines operations specific to a model that uses a standard RDMBS as its backend data repository. Although these operations are specifically defined, they are generally not meant to be invoked by clients directly. Instead, we recommend that clients exclusively use the generic Model-derived methods unless implementation specificity is required.

In most cases, to support generic use of the target model, the type of this model control object is generally also one or more of the following: RetrievingDatasetModelControl, DeletingModelControl, InsertingModelControl, and UpdatingModelControl. Please refer to those classes and the application development documentation for more information on this aspect of interaction between models and their clients.

Users of a SQL-based model who do not wish to use the SQL-specific API should instead rely on the operations specified in the generic-style methods specified in those interfaces. Common exceptions to such usage are use of the various where criteria methods to add qualifications to a QueryModels queries. However, to maintain genericity and abstraction from a given data source, we encourage the use of the generic-style methods whenever possible.

Version:
JATO/1.2.2 $Id: QueryModel.java,v 1.8 2002/03/16 03:26:33 todd Exp $
See Also:
RetrievingModel, DatasetModel, DeletingModel, InsertingModel, UpdatingModel

Method Summary
 QueryFieldSchema getFieldSchema()
          Returns the query field schema object containing metadata about the fields used by this model.
 
Methods inherited from interface com.iplanet.jato.model.sql.SQLModel
getDataSourceName
 
Methods inherited from interface com.iplanet.jato.model.ExecutingModel
execute
 
Methods inherited from interface com.iplanet.jato.model.Model
getName, getValue, getValues, setName, setValue, setValues
 

Method Detail

getFieldSchema

public QueryFieldSchema getFieldSchema()
Returns the query field schema object containing metadata about the fields used by this model.
Returns:
The modle's field schema object