Package com.dassault_systemes.vpmdesktop.vdk0interfaces.interfaces |
com.dassault_systemes.vpmdesktop.vdk0interfaces.interfaces.ENOVICSMessage
Framework : VPMDesktop
Module : VDK0Interfaces
public interface ENOVICSMessage
This interface encapsulates access to a Client-server message.
Each message contains severity and actual text. They can be retrieved after client-server command execution as shown below:
Example :
We will create a client-server command MYCUSTOCOMMAND (a late type of the server command that will
be invoked by this command), set parameter into it, execute it and retrieve a result :
{
// create a command to access server command with late type MYCUSTOCOMMAND
ENOVICSCommand serverCommand = ENOVCSCommandFactory.createCSCommand("MYCUSTOCOMMAND");
// set input parameter with name "my_input_attribute_name" to a value "my_input_attribute_value"
// there are symmetrical methods on the server to retrieve these parameters
serverCommand.setParameter(my_input_attribute_name, my_input_attribute_value);
//Execute server implementation of the command
try{
serverCommand.executeCommand();
}
catch(ENOVCSCommunicationException)
{
//Error Handling
}
// Retrieve Results by name (similar to parameters, retrieve with the same name that was set on the server)
String my_result = serverCommand.getStringResult(my_output_name);
// check messages from the server
ENOVICSMessage [] messages = serverCommand.getMessages();
}
getSeverity
int getSeverity()
This method returns severity of the message returned from the server.
- Returns:
message severity
getMessage
String getMessage()
This method returns contents of the message returned from the server.
- Returns:
message text
Copyright © 2000, Dassault Systèmes. All rights reserved