WebObjects 5.4.2

Class D2WQuery

  extended by com.webobjects.appserver.WOElement
      extended by com.webobjects.appserver.WOComponent
          extended by com.webobjects.directtoweb.D2WEmbeddedComponent
              extended by com.webobjects.directtoweb.D2WQuery
All Implemented Interfaces:
WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

public class D2WQuery
extends D2WEmbeddedComponent

This Direct to Web reusable component displays a query component. See the "Direct to Web" chapter of WebObjects Tools and Techniques for information about the behavior and appearance of this component. Synopsis D2WQuery { [action=anAction;] [displayKeys=keyArray;] entityName=nameString; queryDataSource=aDataSource; [pageConfiguration=configurationName;] }; Bindings action - the action method to invoke when the user clicks Search DB. Is invoked after the D2WQuery component fetches the objects matching the query. displayKeys - the properties of the entity to query (NSArray). You can also represent the array as a string: "(prop1, prop2, ...)". entityName - the name of the entity for this record (String). queryDataSource - an EODataSource containing the objects matching the query. pageConfiguration - the named configuration containing the Web Assistant settings for this component (String). If this binding is not specified, the "*all*" configuration for the query task and the entityName entity is used. See the "Direct to Web" chapter of WebObjects Tools and Techniques for more information about named configurations. Example

 myQuery : D2WQuery {
     entityName = "Movie";
     displayKeys = "(title, roles)";
     queryDataSource = displayGroup.dataSource;
     action = displayGroup.fetch;

See Also:
Serialized Form

Nested Class Summary
Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent
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
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
Constructor Summary
D2WQuery(WOContext aContext)
          Constructs a D2WQuery with the specified context.
Method Summary
 NextPageDelegate newPageDelegate()
          Returns the new page delegate.
Methods inherited from class com.webobjects.directtoweb.D2WEmbeddedComponent
actionPageDelegate, awake, findTarget, setActionPageDelegate, synchronizesVariablesWithBindings
Methods inherited from class com.webobjects.appserver.WOComponent
appendToResponse, application, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail


public D2WQuery(WOContext aContext)
Constructs a D2WQuery with the specified context.

aContext - - the WOContext.
Method Detail


public NextPageDelegate newPageDelegate()
Returns the new page delegate.

newPageDelegate in class D2WEmbeddedComponent
the NextPageDelegate.

Last updated June 2008

Copyright © 2000-2008 Apple Inc.