com.wrq.vhi.script.api

Interface WriteAttributeEvent

All Superinterfaces:

AttributeEvent, EntityEvent, Event, HostSessionEvent, ModelEvent

public interface WriteAttributeEvent
extends AttributeEvent

Write attribute event information.

See Also:

AttributeEventHandler.writeAttribute(com.wrq.vhi.script.api.WriteAttributeEvent)

Method Summary

Modifier and Type	Method and Description
void	defaultWriteAttribute() Writes the value returned by getAttributeWriteValue() to the attribute.
void	defaultWriteAttribute(java.lang.String value) Writes the specified value to the attribute.
java.lang.String	getAttributeWriteValue() Gets the value to be written to the attribute.

Methods inherited from interface com.wrq.vhi.script.api.AttributeEvent

getAttributeMetaData, getAttributeName, getTerminalRegion

Methods inherited from interface com.wrq.vhi.script.api.EntityEvent

getEntityName, getTabStops

Methods inherited from interface com.wrq.vhi.script.api.HostSessionEvent

getHostSession

Methods inherited from interface com.wrq.vhi.script.api.ModelEvent

getClientSession, getCurrentOperation, getCurrentProcedure, getModelContext

Methods inherited from interface com.wrq.vhi.script.api.Event

checkForTimeout, createErrorMessage, createErrorMessage, createHostSession, createUserErrorMessage, getEventStack, getHandlerProperty, getLogger, isDesignEnvironment

Method Detail

getAttributeWriteValue

java.lang.String getAttributeWriteValue()

Gets the value to be written to the attribute. The model-defined prepending, appending and padding will not have been performed on this value.

Returns:

the value to be written

defaultWriteAttribute

void defaultWriteAttribute()
                    throws ApptrieveException

Writes the value returned by getAttributeWriteValue() to the attribute. The prepending, appending and padding of spaces will be performed as defined in the model. Any before, underfill and after operations defined on the attribute will be executed.

Throws:

ApptrieveException - if the write fails

defaultWriteAttribute

void defaultWriteAttribute(java.lang.String value)
                    throws ApptrieveException

Writes the specified value to the attribute. The prepending, appending and padding of spaces will be performed as defined in the model. Any before, underfill and after operations defined on the attribute will be executed.

Parameters:

value - the value to write

Throws:

ApptrieveException - if the write fails