WebObjects 5.4.2

com.webobjects.directtoweb
Class D2WStatelessComponent

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.D2WStatelessComponent
All Implemented Interfaces:
WOActionResults, DTWGeneration, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable
Direct Known Subclasses:
D2WDisplayBoolean, D2WDisplayDate, D2WDisplayHyperlink, D2WDisplayImage, D2WDisplayImageFromPath, D2WDisplayMailTo, D2WDisplayNumber, D2WDisplayString, D2WDisplayStyledDate, D2WDisplayStyledNumber, D2WDisplayStyledString, D2WDisplayThresholdColoredNumber, D2WDisplayToManyFault, D2WDisplayToOne, D2WDisplayToOneFault, D2WEditUneditable, EditComponent, QueryComponent

public class D2WStatelessComponent
extends D2WComponent

The D2WStatelessComponent class represents a stateless Direct to Web component. For a stateless component, a single instance is shared between multiple sessions. Many property-level components are stateless.

See Also:
WOComponent.isStateless(), 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
 
Fields inherited from class com.webobjects.directtoweb.D2WComponent
currentObjectKey
 
Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions
KeyPathSeparator
 
Constructor Summary
D2WStatelessComponent(WOContext aContext)
          Creates an instance of D2WStatelessComponent with the specified context.
 
Method Summary
 D2WContext d2wContext()
          Provides access to the local instance of D2WContext.
 boolean isStateless()
          Indicates that the component is stateless.
 D2WContext localContext()
          Deprecated. Use the method d2wContext instead.
 EOEnterpriseObject object()
          Provides access to the local instance of EOEnterpriseObject.
 void reset()
          Resets the component.
 
Methods inherited from class com.webobjects.directtoweb.D2WComponent
allEntities, allowCollapsing, applicationPort, assistantPort, attribute, backgroundColorForHeaderRow, backgroundColorForPage, backgroundColorForTable, backgroundColorForTableDark, backgroundColorForTableLight, color, currentSettings, currentUrl, 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, logout, objectPropertyValue, objectPropertyValueIsNonNull, pageTitle, property, propertyKey, propertyValueClassName, relationship, replacementAssociationForAssociation, 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, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

D2WStatelessComponent

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

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

isStateless

public boolean isStateless()
Indicates that the component is stateless. Returns true for D2WStatelessComponent and its subclasses.

Overrides:
isStateless in class WOComponent
Returns:
true
See Also:
WOComponent.isStateless()

localContext

@Deprecated
public D2WContext localContext()
Deprecated. Use the method d2wContext instead.

The method localContext has been deprecated. Use the method d2wContext instead.

Overrides:
localContext in class D2WComponent
Returns:
instance of D2WContext
See Also:
D2WStatelessComponent.d2wContext()

d2wContext

public D2WContext d2wContext()
Provides access to the local instance of D2WContext. In a stateless component, the local instance, once set, does not change until the component has been reset.

Overrides:
d2wContext in class D2WComponent
Returns:
instance of D2WContext
See Also:
D2WStatelessComponent.reset(), D2WComponent.d2wContext()

object

public EOEnterpriseObject object()
Provides access to the local instance of EOEnterpriseObject. In a stateless component, the local instance, once set, does not change until the component has been reset.

Overrides:
object in class D2WComponent
Returns:
instance of EOEnterpriseObject
See Also:
D2WStatelessComponent.reset(), D2WComponent.object()

reset

public void reset()
Resets the component.

The current implementation clears the local instance of D2WContext and the local instance of EOEnterpriseObject.

The implementation is subject to change in future releases.

Overrides:
reset in class WOComponent
See Also:
D2WStatelessComponent.d2wContext(), D2WStatelessComponent.object()

Last updated June 2008

Copyright © 2000-2008 Apple Inc.