com.inductiveautomation.ignition.client.sqltags

Interface WriteOperation

All Known Implementing Classes:

AbstractWriteOperation, ErrorWriteOp, PendingWriteOp, SuccessfulWrite

public interface WriteOperation

A WriteOperation is returned in response to a write request for a tag. The WriteOperation can be queried to see if the write was immediately successful, or if the operation may take some time. Interested parties can then register as a change listener on the operation, to be notified when it finishes.

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	getResponseError() Returns any exception that occurred during the write.
java.lang.String	getResponseMessage() Returns the response message, if any.
TagPath	getTagPath() Returns the path of the tag that was written to.
java.lang.Object	getValue() Returns the value that was attempted to be written.
WriteResponse	getWriteResponse() Returns the WriteResponse for this operation.
void	setChangeListener(javax.swing.event.ChangeListener listener) Sets the change listener to listen for when this operation has finished.

Method Detail

getWriteResponse

WriteResponse getWriteResponse()

Returns the WriteResponse for this operation. If this is PENDING, one should register as a change listener to be notified when the response comes in.

Returns:

setChangeListener

void setChangeListener(javax.swing.event.ChangeListener listener)

Sets the change listener to listen for when this operation has finished.

Parameters:

listener -

getResponseMessage

java.lang.String getResponseMessage()

Returns the response message, if any.

Returns:

getResponseError

java.lang.Throwable getResponseError()

Returns any exception that occurred during the write.

Returns:

getTagPath

TagPath getTagPath()

Returns the path of the tag that was written to.

getValue

java.lang.Object getValue()

Returns the value that was attempted to be written.