com.wrq.vhi.script.api
Interface WriteAttributesEvent

All Superinterfaces:
EntityEvent, Event, HostSessionEvent, ModelEvent

public interface WriteAttributesEvent
extends EntityEvent, HostSessionEvent

Write attributes event information.

See Also:
EntityEventHandler.writeAttributes(com.wrq.vhi.script.api.WriteAttributesEvent)

Method Summary
 void defaultWriteAttributes()
          Writes the attributes to the screen using the default algorithm.
 void defaultWriteAttributes(java.util.Map values)
          Writes the attributes to the screen using the default algorithm.
 java.util.Map getAttributeWriteValues()
          Gets the set of attributes and associated values to be written.
 void writeAttribute(java.lang.String name, java.lang.String value)
          Writes the specified value to the specified attribute.
 
Methods inherited from interface com.wrq.vhi.script.api.EntityEvent
getEntityName, getTabStops
 
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
 
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

getAttributeWriteValues

java.util.Map getAttributeWriteValues()
Gets the set of attributes and associated values to be written.

Returns:
A map of attribute names to attribute values

writeAttribute

void writeAttribute(java.lang.String name,
                    java.lang.String value)
                    throws ApptrieveException
Writes the specified value to the specified attribute. If the cursor is not at the attribute's location, a MoveCursor command will automatically be issued. Upon successfully positioning the cursor at the attribute, the value will be written to the screen, firing the appropriate AttributeEventHandler.writeAttribute(com.wrq.vhi.script.api.WriteAttributeEvent), if any.

Parameters:
name - the attribute name
value - the value to write
Throws:
ApptrieveException

defaultWriteAttributes

void defaultWriteAttributes()
                            throws ApptrieveException
Writes the attributes to the screen using the default algorithm. See defaultWriteAttributes(java.util.Map) for a description of the default algorithm.

Throws:
ApptrieveException

defaultWriteAttributes

void defaultWriteAttributes(java.util.Map values)
                            throws ApptrieveException
Writes the attributes to the screen using the default algorithm. For character mode hosts, attributes will be written in one of two ways:

Parameters:
values - map of attribute names to attribute values
Throws:
ApptrieveException - if the write fails