com.webobjects.appserver
Class WOAssociation.Event

java.lang.Object
  |
  +--com.webobjects.eocontrol.EOEvent
        |
        +--com.webobjects.appserver.WOEvent
              |
              +--com.webobjects.appserver.WOAssociation.Event

Enclosing class:

WOAssociation

public static class WOAssociation.Event

extends WOEvent

The WOAssociation.Event class is used to time value assignment/retrieval at the component level.

See Also:

WOEvent, WOAssociation.ValueForKeyPathEvent, WOAssociation.TakeValueForKeyPathEvent

Fields inherited from class com.webobjects.appserver.WOEvent

AssociationSignature, ComponentSignature, PageSignature

Fields inherited from class com.webobjects.eocontrol.EOEvent

BasicEventSignature, EventGroupName

Constructor Summary

WOAssociation.Event()

Method Summary

String	bindingName() Used by The WOAssociationEventRow component in WOJExtensions to display the association's binding name.
String	comment() This method provides information for the event display.
String	declarationName() Used by The WOAssociationEventRow component in WOJExtensions to display the association's declaration name.
String	displayComponentName() Used by The WOEventDisplay page in WOJExtensions to determine the event row name displayed.
boolean	isPush() Used by The WOAssociationEventRow component to determine the event type.
String	keyPath() Used by The WOAssociationEventRow component in WOJExtensions to display the association's key path.
void	setKeyPath(String aKeyPath) Unused, but added for key value coding symmetry.
String	signatureOfType(int aType) Used by the WOAssociationEventRow component in WOJExtensions to display the event signature.

Methods inherited from class com.webobjects.appserver.WOEvent

setComponentName, setPageName, title, toString

Methods inherited from class com.webobjects.eocontrol.EOEvent

aggregateEvents, classDescription, compare, description, duration, durationWithoutSubevents, eventTypeDescriptions, groupEvents, info, markAtomicWithInfo, markEnd, markStartWithInfo, parentEvent, setInfo, setType, startDate, subevents, type

Methods inherited from class java.lang.Object

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

Constructor Detail

WOAssociation.Event

public WOAssociation.Event()

Method Detail

bindingName

public String bindingName()

Used by The WOAssociationEventRow component in WOJExtensions to display the association's binding name.

Returns:

a binding name

comment

public String comment()

This method provides information for the event display.

Overrides:

comment in class WOEvent

Returns:

the declaration name and the binding name concatenated.

declarationName

public String declarationName()

Used by The WOAssociationEventRow component in WOJExtensions to display the association's declaration name.

Returns:

a declaration name

displayComponentName

public String displayComponentName()

Used by The WOEventDisplay page in WOJExtensions to determine the event row name displayed.

Overrides:

displayComponentName in class EOEvent

Returns:

"WOAssociationEventRow", which is also in WOJExtensions

isPush

public boolean isPush()

Used by The WOAssociationEventRow component to determine the event type.

Returns:

true if this is a value assignment event (push), false if this is a value retrieval event (pull).

keyPath

public String keyPath()

Used by The WOAssociationEventRow component in WOJExtensions to display the association's key path.

Returns:

a key path

setKeyPath

public void setKeyPath(String aKeyPath)

Unused, but added for key value coding symmetry.

Parameters:

aKeyPath - the value of the keypath.

signatureOfType

public String signatureOfType(int aType)

Used by the WOAssociationEventRow component in WOJExtensions to display the event signature.

Overrides:

signatureOfType in class WOEvent

Parameters:

aType - a type integer

Returns:

this event's comment() if the event signature passed as a parameter is a WOEvent.AssociationSignature

See Also:

for various signature type.