com.webobjects.directtoweb
Class D2WQuery

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          com.webobjects.directtoweb.D2WEmbeddedComponent
              com.webobjects.directtoweb.D2WQuery

All Implemented Interfaces:

Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, WOActionResults

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 inherited from class com.webobjects.appserver.WOComponent

WOComponent.Event

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor

Nested classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes inherited from class com.webobjects.foundation.NSValidation

NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

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, sleep, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

D2WQuery

public D2WQuery(WOContext aContext)

Constructs a D2WQuery with the specified context.

Parameters:

aContext - - the WOContext.

Method Detail

newPageDelegate

public NextPageDelegate newPageDelegate()

Returns the new page delegate.

Overrides:

newPageDelegate in class D2WEmbeddedComponent

Returns:

the NextPageDelegate.