Package com.tibco.ep.testing.framework
Class Results
java.lang.Object
com.tibco.ep.testing.framework.Results
Result from an administration command
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionerror()
Deprecated.List<com.tibco.ep.dtm.management.DtmResults>
Get all resultsGet list of status messagesReturn the error messages of the commandDeprecated.Warning: this method excludes the source of each status usegetCommandStatusMessages()
insteadPretty print the service name, command, parameters, return code, status messages, error messages, and results.int
Return the return code of the commandOptional<com.tibco.ep.dtm.management.DtmResults>
Deprecated.Warning: this method excludes results when the command returns more than one result set usegetCommandResults()
insteadtoString()
Convert results set to a simple string
-
Constructor Details
-
Results
Results(String serviceName, String command, String target, Map<String, String> parameters, List<com.tibco.ep.dtm.management.DtmResults> results, List<Message> statuses, int returnCode, List<Message> errors) Constructor- Parameters:
serviceName
- service namecommand
- commandtarget
- targetparameters
- command parametersresults
- list of resultsstatuses
- lists of statusesreturnCode
- return codeerrors
- list of errors
-
-
Method Details
-
getCommandResults
Get all results
- Returns:
- List of results. If no results, list will be of zero length.
-
returnCode
public int returnCode()Return the return code of the command
- DtmCommand.COMMAND_SUCCEEDED - Return code indicating command succeeded
- DtmCommand.COMMAND_CANCELED - Return code indicating command was canceled
- DtmCommand.COMMAND_WAIT_TIMEDOUT - Return code indicating command wait timed out
- Returns:
- return code
-
getErrorMessages
Return the error messages of the command
- Returns:
- List of error messages. If no errors, list will be of zero length.
-
getCommandStatusMessages
Get list of status messages
- Returns:
- List of status messages. If no errors, list will be of zero length.
-
toString
Convert results set to a simple string
-
prettyPrint
Pretty print the service name, command, parameters, return code, status messages, error messages, and results.- Returns:
- Formatted results.
-
toDtmResults
Deprecated.Warning: this method excludes results when the command returns more than one result set usegetCommandResults()
insteadConvert last results set to DtmResults
- Returns:
- results set
-
error
Deprecated.Warning: this method excludes errors when the command returns more than one error usegetErrorMessages()
insteadReturn the last error message of the command
- Returns:
- error message - null on no error
-
getStatusMessages
Deprecated.Warning: this method excludes the source of each status usegetCommandStatusMessages()
insteadGet list of status messages
- Returns:
- list of status messages
-
getErrorMessages()
instead