WebObjects 5.2

com.webobjects.woextensions
Class WOLongResponsePage

java.lang.Object
  |
  +--com.webobjects.appserver.WOElement
        |
        +--com.webobjects.appserver.WOComponent
              |
              +--com.webobjects.woextensions.WOLongResponsePage
All Implemented Interfaces:
Cloneable, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Runnable, Serializable, WOActionResults

public abstract class WOLongResponsePage
extends WOComponent
implements Runnable

See Also:
Serialized Form

Inner classes inherited from class com.webobjects.appserver.WOComponent
WOComponent.Event
 
Inner classes inherited from class com.webobjects.foundation.NSKeyValueCoding
NSKeyValueCoding.DefaultImplementation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.Utility, NSKeyValueCoding.ValueAccessor
 
Inner classes inherited from class com.webobjects.foundation.NSKeyValueCodingAdditions
NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility
 
Inner classes inherited from class com.webobjects.foundation.NSValidation
NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding
NullValue
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
WOLongResponsePage(WOContext aContext)
           
 
Method Summary
 void appendToResponse(WOResponse aResponse, WOContext aContext)
          Forces the component to generate its interface and output it in the response's content.
 WOComponent cancel()
           
 WOComponent cancelPageForStatus(Object aStatus)
           
 WOActionResults invokeAction(WORequest aRequest, WOContext aContext)
          Tells the component to execute any action specified in the request.
 boolean isCancelled()
           
 WOComponent pageForException(Exception exception)
           
 WOComponent pageForResult(Object aResult)
           
abstract  Object performAction()
           
 WOComponent refresh()
           
 double refreshInterval()
           
 WOComponent refreshPageForStatus(Object aStatus)
           
 Object result()
           
 void run()
           
 void setCancelled(boolean aBool)
           
 void setRefreshInterval(double interval)
           
 void setResult(Object anObject)
           
 void setStatus(Object anObject)
           
 Object status()
           
 
Methods inherited from class com.webobjects.appserver.WOComponent
application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, sleep, synchronizesVariablesWithBindings, 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

WOLongResponsePage

public WOLongResponsePage(WOContext aContext)
Method Detail

appendToResponse

public void appendToResponse(WOResponse aResponse,
                             WOContext aContext)
Description copied from class: WOComponent
Forces the component to generate its interface and output it in the response's content. Component objects associated with a response receive this message during the last phase of the component request handling, or when returned by a direct action method. In the append-to-response phase, application objects (particularly the response page instance itself) generate the HTML content of the page. WOComponent's default implementation of this method invokes the appendToResponse method on the root WOElement object of the component template, which in turn invokes appendToResponse. Subclasses of WOComponent can override this method to replace or supplement the default behavior with custom logic.
Overrides:
appendToResponse in class WOComponent
Following copied from class: com.webobjects.appserver.WOComponent
Parameters:
aResponse - the HTTP response that an application returns to a Web server to complete a cycle of the request-response loop
aContext - context of a transaction
See Also:
WOComponent.invokeAction(WORequest aRequest, WOContext aContext), WOComponent.takeValuesFromRequest(WORequest aRequest, WOContext aContext)

cancel

public WOComponent cancel()

cancelPageForStatus

public WOComponent cancelPageForStatus(Object aStatus)

invokeAction

public WOActionResults invokeAction(WORequest aRequest,
                                    WOContext aContext)
Description copied from class: WOComponent
Tells the component to execute any action specified in the request. It is systematically called during the middle phase of the component request handling. All WOComponent objects associated with a request page invoke this method. In this middle phase, the invokeAction method is propagated through the WOElement objects of the page. The dynamic element on which the user has acted (by, for example, clicking a button) responds by triggering the method in the request component that is bound to the action. WOComponent's default implementation of this method invokes invokeAction on the root WOElement object of the component template.
Overrides:
invokeAction in class WOComponent
Following copied from class: com.webobjects.appserver.WOComponent
Parameters:
aRequest - the request
aContext - context of the transaction
Returns:
a WOActionResults containing the result of the request
See Also:
WOComponent.appendToResponse(WOResponse aResponse, WOContext aContext), WOComponent.takeValuesFromRequest(WORequest aRequest, WOContext aContext)

isCancelled

public boolean isCancelled()

pageForException

public WOComponent pageForException(Exception exception)

pageForResult

public WOComponent pageForResult(Object aResult)

performAction

public abstract Object performAction()

refresh

public WOComponent refresh()

refreshInterval

public double refreshInterval()

refreshPageForStatus

public WOComponent refreshPageForStatus(Object aStatus)

result

public Object result()

run

public void run()
Specified by:
run in interface Runnable

setCancelled

public void setCancelled(boolean aBool)

setRefreshInterval

public void setRefreshInterval(double interval)

setResult

public void setResult(Object anObject)

setStatus

public void setStatus(Object anObject)

status

public Object status()

Last updated Fri Feb 21 13:15:00 PST 2003.

Copyright © 2003 Apple Computer, Inc.