D2WQueryPage

D2WQueryPage

Package: com.webobjects.directtoweb

Inherits from:D2WPage

Implements:

QueryPageInterface
com.webobjects.directtoweb.generation.DTWGeneration

Subclasses:

Class Description

This class provides the behavior for the query-page Direct to Web templates, specifically BASQueryPage, NEUQueryPage, and WOLQueryPage. The classes for these components inherit directly from D2WQueryPage and define no additional variables or methods.

Most of the methods in this class are accessed (via the EOKeyValueCoding interface defined in the EOControl framework) from the Direct to Web template's bindings (.wod) file. If you create a Direct to Web template from a query page, you can invoke the methods in this class in the same way. See the "Direct to Web" chapter of WebObjects Tools and Techniques for more information about creating a Direct to Web template.

Method Types

Constructors

public D2WQueryPage()

Fields

displayGroup

Actions

queryAction

Managing the Fetch Specification

fetchLimit
fetchSpecOptions
isDeep
refreshRefetchedObjects
usesDistinct

Private Methods

qualifier
queryDataSource
replacementAssociationForAssociation
setQueryDataSource

Constructors

D2WQueryPage

public D2WQueryPage()

Standard Java no-argument constructor.

Fields

displayGroup
com.webobjects.appserver.WODisplayGroup

The WODisplayGroup object that performs the query.

Methods

fetchLimit

public int fetchLimit()

The maximum number of objects matching the query that the receiver's display group fetches. The fetch limit is used by the receiver's fetch specification.

fetchSpecOptions

public String fetchSpecOptions()

Returns a String containing the state of the receiver's fetch specification options. These options are: isDeep, usesDistinct, refreshesRefetchedObjects, and fetchLimit.

isDeep

public boolean isDeep()

A flag indicating whether or not fetches should include sub-entities of the query fetch specification's entity. Defaults to false. This flag is used by the receiver's fetch specification.

qualifier

public EOQualifier qualifier()

This method is intentionally undocumented. You should never have to invoke or customize it.

queryAction

public WOComponent queryAction()

This action method is invoked when the user clicks Search in the query page. To specify the search behavior, override the nextPageDelegate method.

See Also:
nextPageDelegate (D2WPage)

queryDataSource

public EODataSource queryDataSource()

This method is intentionally undocumented. You should never have to invoke or customize it.

refreshRefetchedObjects

public boolean refreshRefetchedObjects()

A flag indicating whether or not existing objects are overwritten with fetched values when they've been updated or changed. Defaults to false, that is, existing objects aren't touched when their data is refetched (the fetched data is simply discarded). This flag is used by the receiver's fetch specification.

replacementAssociationForAssociation

public WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, DTWTemplate aTemplate, WOContext aContext)

This method is intentionally undocumented. You should never have to invoke or customize it.

setQueryDataSource

public void setQueryDataSource(EODataSource dataSource)

This method is intentionally undocumented. You should never have to invoke or customize it.

usesDistinct

public boolean usesDistinct()

A flag indicating whether or not duplicate objects or records are removed after fetching. Defaults to false. This flag is used by the receiver's fetch specification.