com.wrq.vhi.script.api
Interface WriteFieldEvent

All Superinterfaces:
EntityEvent, Event, FieldEvent, HostSessionEvent, ModelEvent, RecordEvent, RecordSetEvent

public interface WriteFieldEvent
extends FieldEvent

Write field event information.

See Also:
FieldEventHandler.writeField(com.wrq.vhi.script.api.WriteFieldEvent)

Method Summary
 void defaultWriteField()
          Writes the value returned by getFieldWriteValue() to the field.
 void defaultWriteField(java.lang.String value)
          Writes the specified value to the field.
 java.lang.String getFieldWriteValue()
          Gets the value to be written to the field.
 
Methods inherited from interface com.wrq.vhi.script.api.FieldEvent
getFieldMetaData, getFieldName
 
Methods inherited from interface com.wrq.vhi.script.api.RecordEvent
getHostRecordIndex, getRecordIndex, getRecordStateObject, isRecordStateObject, setRecordStateObject
 
Methods inherited from interface com.wrq.vhi.script.api.RecordSetEvent
getPageNumber, getRecordSetContext, getRecordSetMetaData, getRecordSetName
 
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

getFieldWriteValue

java.lang.String getFieldWriteValue()
Gets the value to be written to the field. The model-defined prepending, appending and padding will not have been performed on this value.

Returns:
the value to be written

defaultWriteField

void defaultWriteField()
                       throws ApptrieveException
Writes the value returned by getFieldWriteValue() to the field. The prepending, appending and padding of spaces will be performed as defined in the model. Any before, underfill and after operations defined on the field will be executed.

Throws:
ApptrieveException - if the write fails

defaultWriteField

void defaultWriteField(java.lang.String value)
                       throws ApptrieveException
Writes the specified value to the field. The prepending, appending and padding of spaces will be performed as defined in the model. Any before, underfill and after operations defined on the field will be executed.

Parameters:
value - the value to write
Throws:
ApptrieveException - if the write fails