Interface WriteOperation
- All Known Implementing Classes:
AbstractWriteOperation
,ErrorWriteOp
,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 TypeMethodDescriptionReturns any exception that occurred during the write.Returns the response message, if any.Returns the path of the tag that was written to.getValue()
Returns the value that was attempted to be written.Returns the WriteResponse for this operation.void
setChangeListener
(ChangeListener listener) Sets the change listener to listen for when this operation has finished.
-
Method Details
-
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. -
setChangeListener
Sets the change listener to listen for when this operation has finished. -
getResponseMessage
String getResponseMessage()Returns the response message, if any. -
getResponseError
Throwable getResponseError()Returns any exception that occurred during the write. -
getTagPath
TagPath getTagPath()Returns the path of the tag that was written to. -
getValue
Object getValue()Returns the value that was attempted to be written.
-