public interface ModifyResults
CommandHandler
.Modifier and Type | Field and Description |
---|---|
static int |
ERROR_PROCESSING_COMMAND
Completion Status indicator.
|
static int |
PROCESSED_COMMAND
Completion Status indicator.
|
static int |
UNKNOWN_COMMAND
Completion Status indicator.
|
Modifier and Type | Method and Description |
---|---|
int |
getCompletionStatus()
Return the completion status indicator.
|
java.lang.Object |
getProperty(java.lang.String key)
Returns the property given the
key from the associated ModifyResults |
java.util.List<java.lang.String> |
getResponses()
List of String Objects, each representing a
command response message. |
boolean |
responsesContainMSGIDs()
Indication that responses contain message identifiers or not.
|
void |
setCompletionStatus(int completionStatus)
Set a completion status.
|
void |
setProperty(java.lang.String key,
java.lang.Object value)
Sets the property given the
key from the associated ModifyResults |
void |
setResponses(java.util.List<java.lang.String> responses)
Set
List of String Objects, each representing a
command response message. |
void |
setResponsesContainMSGIDs(boolean value)
Set indication that responses contain message identifiers
|
static final int PROCESSED_COMMAND
static final int UNKNOWN_COMMAND
CommandHandler
.static final int ERROR_PROCESSING_COMMAND
java.util.List<java.lang.String> getResponses()
List
of String
Objects, each representing a
command response message. Message strings may be prefixed with a
message identifier (Note: method responsesContainMSGIDs
indicates the presence of a message identifier). The response message
text must be representable in IBM-1047. The messages language should be
English for consistency.
If the responses are not prefixed with message identifier then the command processing code will prefix each response with its own message identifier.
List
of String
Objects each representing a command
responsevoid setResponses(java.util.List<java.lang.String> responses)
List
of String
Objects, each representing a
command response message. Message strings may be prefixed with a
message identifier (Note: method responsesContainMSGIDs
indicates the presence of a message identifier).
If the responses are not prefixed with message identifier then the command processing code will prefix each response with its own message identifier.
responses
- List
of command response String
Objects
The response message text must be representable in IBM-1047.
The messages language should be English for consistency.void setCompletionStatus(int completionStatus)
PROCESSED_COMMAND
,
UNKNOWN_COMMAND
and ERROR_PROCESSING_COMMAND
.completionStatus
- completion status indicator representing the results of processing the
commandint getCompletionStatus()
PROCESSED_COMMAND
,
UNKNOWN_COMMAND
and ERROR_PROCESSING_COMMAND
.java.lang.Object getProperty(java.lang.String key)
key
from the associated ModifyResults
key
- key for the propertyModifyResults
void setProperty(java.lang.String key, java.lang.Object value)
key
from the associated ModifyResults
key
- key for the propertyvalue
- value for the propertyboolean responsesContainMSGIDs()
true
if messages start with message identifiers, false
otherwise.void setResponsesContainMSGIDs(boolean value)
value
- true
indicates responses have message identifiers, false
otherwise.