org.sandev.basics.structs
Class TestActionStruct

java.lang.Object
  org.sandev.basics.structs.TestActionStruct

Direct Known Subclasses:

TestAction

public class TestActionStruct
extends java.lang.Object

An outbound message to respond with or send.

summary fields: commType message.shortName
This message has the following verb forms: update
declared printname: Test Action
help text: An outbound test message.

Field Summary

protected int	commType How the outbound message should be delivered.
protected SandMessage	message The outbound message.
protected int	returnMsgStatus The expected getSandTransmitStatus for the message returned from a synchronous call.
protected java.lang.String	targetNodeOverride The instance name of the target node receiving this message, if different from the general configuration.

Constructor Summary

TestActionStruct()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

commType

protected int commType

How the outbound message should be delivered. If this action is in response to a synchronous inbound request (call or query), then the response action must be synchronous. Otherwise the action may be either synchronous (call/query), or asynchronous (send/post).

declared default value: 0

enumerated constant values:

• SYNC("synchronous (query, call)") = 0
  
• ASYNC("asynchronous (send, post)") = 1
  

declared invalid value: -1
declared printname: communications type
help text: How the outbound message should be delivered. If this action is in response to a synchronous inbound request (call or query), then the response action must be synchronous. Otherwise the action may be either synchronous (call/query), or asynchronous (send/post).

targetNodeOverride

protected java.lang.String targetNodeOverride

The instance name of the target node receiving this message, if different from the general configuration. Outbound messages are sent to the node instance configured for the MessageDriver, unless otherwise specified in this field.

Length in characters, normal: 30 max: 60
declared printname: node instance override
help text: The instance name of the target node receiving this message, if different from the general configuration.

message

protected SandMessage message

The outbound message.

help text: The outbound message.

returnMsgStatus

protected int returnMsgStatus

The expected getSandTransmitStatus for the message returned from a synchronous call.

declared default value: 0

enumerated constant values:

• STATUS_NORMAL("Normal") = 0
  
• STATUS_SYSERROR("System Error") = 1
  
• STATUS_SANDERROR("SAND Error") = 2
  
• STATUS_APPERROR("Application Error") = 3
  

declared invalid value: -1
declared printname: expected return message status
help text: The expected getSandTransmitStatus for the message returned from a synchronous call. This defaults to STATUS_NORMAL, but if the action being taken is supposed to generate an error, then this can be set to an error value to indicate that was an expected result. The values correspond to the STATUS* values defined in SandTransmitMessage.

Constructor Detail

TestActionStruct

public TestActionStruct()