WebObjects 5.4.2

com.webobjects.directtoweb
Class D2WQueryAllEntitiesPage

java.lang.Object
  extended by com.webobjects.appserver.WOElement
      extended by com.webobjects.appserver.WOComponent
          extended by com.webobjects.directtoweb.D2WComponent
              extended by com.webobjects.directtoweb.D2WPage
                  extended by com.webobjects.directtoweb.D2WQueryAllEntitiesPage
All Implemented Interfaces:
WOActionResults, DTWGeneration, QueryAllPageInterface, QueryPageInterface, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable
Direct Known Subclasses:
BASQueryAllEntitiesPage, NEUQueryAllPage, WOLQueryAllPage

public class D2WQueryAllEntitiesPage
extends D2WPage
implements QueryAllPageInterface, DTWGeneration

The D2WQueryAllEntitiesPage class provides the behavior for the query-all page Direct to Web templates, specifically BASQueryAllEntitesPage, NEUQueryAllPage, and WOLQueryAllPage. The classes for these components inherit directly from D2WQueryAllEntitiesPage and define no additional methods or variables.

Most of the methods in this class are accessed, via the EOKeyValueCoding interface defined in the EOControl framework, from the bindings (.wod) file of the Direct to Web template. If you create a Direct to Web template from a query-all page, you can invoke the methods in this class in the same way.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent
WOComponent.Event
 
Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility
 
Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
 
Field Summary
 WODisplayGroup displayGroup
          The WODisplayGroup object that performs the query.
 
Fields inherited from class com.webobjects.directtoweb.D2WComponent
currentObjectKey
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
D2WQueryAllEntitiesPage(WOContext aContext)
          Creates an instance of D2WQueryAllEntitiesPage with the specified context.
 
Method Summary
 WOComponent queryAction()
          Is invoked when a user clicks the search button next to an entity in the query-all page.
 EODataSource queryDataSource()
          Returns the receiver's EODataSource (defined in the EOControl Framework).
 WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation, String oldBinding, DTWTemplate aTemplate, WOContext aContext)
          Replace the bindings queryAction and showRegularQueryAction.
 WOComponent showRegularQueryAction()
          Is invoked when a user clicks the More Options button next to an entity.
 
Methods inherited from class com.webobjects.directtoweb.D2WPage
alternateRowColor, dataSource, descriptionForResponse, extraBindings, finalize, nextPage, nextPageDelegate, pageWrapperName, setDataSource, setExtraBindings, setNextPage, setNextPageDelegate, showCancel
 
Methods inherited from class com.webobjects.directtoweb.D2WComponent
allEntities, allowCollapsing, applicationPort, assistantPort, attribute, backgroundColorForHeaderRow, backgroundColorForPage, backgroundColorForTable, backgroundColorForTableDark, backgroundColorForTableLight, color, currentSettings, currentUrl, d2wContext, d2wContextVisibleEntityNamesCountPlus1, defaultRowspan, displayNameForKeyWhenRelationship, displayNameForProperty, displayPropertyKeys, dynamicPages, entity, entityName, formatter, generationReplacementFor, generationReplacementForCurrentObject, hasCustomKey, hasEntity, hasNoColor, homeClicked, homeHref, isEditing, isEntityReadOnly, isEntityReadOnly, isLiveAssistantEnabled, isNotBoldAsBoolean, isNotItalicAsBoolean, isPropertyAnAttribute, isWebAssistantActive, isWebAssistantConnected, isWebAssistantEnabled, keyForGenerationReplacementForVariableNamed, keyWhenRelationship, lastUrl, length, localContext, logout, object, objectPropertyValue, objectPropertyValueIsNonNull, pageTitle, property, propertyKey, propertyValueClassName, relationship, resourcePathURL, sessionID, setCurrentSettings, setDynamicPages, setEntities, setEntity, setEntityName, setLocalContext, setObject, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames
 
Methods inherited from class com.webobjects.appserver.WOComponent
appendToResponse, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.webobjects.directtoweb.QueryPageInterface
setNextPageDelegate
 

Field Detail

displayGroup

public WODisplayGroup displayGroup
The WODisplayGroup object that performs the query.

Constructor Detail

D2WQueryAllEntitiesPage

public D2WQueryAllEntitiesPage(WOContext aContext)
Creates an instance of D2WQueryAllEntitiesPage with the specified context.

Parameters:
aContext - instance of WOContext
See Also:
D2WPage.D2WPage(WOContext)
Method Detail

queryDataSource

public EODataSource queryDataSource()
Description copied from interface: QueryPageInterface
Returns the receiver's EODataSource (defined in the EOControl Framework).

Specified by:
queryDataSource in interface QueryPageInterface
Returns:
a datasource initialized with a qualifier that matches the search criteria the user specified in the query page. This datasource, for example, could be passed on to a List page to display the results.

showRegularQueryAction

public WOComponent showRegularQueryAction()
Is invoked when a user clicks the More Options button next to an entity. Creates and returns a query page for the entity.

Returns:
a query page for the entity

queryAction

public WOComponent queryAction()
Is invoked when a user clicks the search button next to an entity in the query-all page. Creates and returns a list page displaying objects that match the query.

Returns:
a list page displaying objects that match the query

replacementAssociationForAssociation

public WOAssociation replacementAssociationForAssociation(WOAssociation oldAssociation,
                                                          String oldBinding,
                                                          DTWTemplate aTemplate,
                                                          WOContext aContext)
Replace the bindings queryAction and showRegularQueryAction.

The implementation is subject to change in future releases.

Specified by:
replacementAssociationForAssociation in interface DTWGeneration
Overrides:
replacementAssociationForAssociation in class D2WPage
Parameters:
oldAssociation - instance of WOAssociation
oldBinding - instance of String
aTemplate - instance of DTWTemplate
aContext - instance of WOContext
Returns:
instance of WOAssociation
See Also:
D2WQueryAllEntitiesPage.queryAction(), D2WQueryAllEntitiesPage.showRegularQueryAction(), D2WPage.replacementAssociationForAssociation(WOAssociation, String, DTWTemplate, WOContext)

Last updated June 2008

Copyright © 2000-2008 Apple Inc.