Package com.uc4.communication.requests

Class ExecuteObjects.ExecuteObjectsResponse

java.lang.Object

com.uc4.communication.requests.ExecuteObjects.ExecuteObjectsResponse

Enclosing class:

ExecuteObjects

public class ExecuteObjects.ExecuteObjectsResponse
extends Object

Class hold response data from the executed request

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExecuteObjectsResponse(int runId, int messageNumber, String messageInsert, String messageText)

Method Summary

Modifier and Type	Method	Description
String	getMessageInsert()	This method returns a message insert for the message number returned by getMessageNumber.
int	getMessageNumber()	This method returns a message number in case that the execution failed.
String	getMessageText()	Returns the error message translated in the language of the user.
int	getRunID()	Returns the RunID of this request.

Methods inherited from class java.lang.Object

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

Constructor Details

ExecuteObjectsResponse

protected ExecuteObjectsResponse(int runId,
 int messageNumber,
 String messageInsert,
 String messageText)

Method Details

getRunID

public int getRunID()

Returns the RunID of this request. If the UC4 Object could not be generated this method returns 0 and the method getMsgbox() returns the error message. The return value is also 0 if the request has never been sent.

Returns:

RunID or 0 if there was an error. Use the method getMessageNumber() and getMessageInsert() to get more information

getMessageNumber

public int getMessageNumber()

This method returns a message number in case that the execution failed. A return value of 0 means that there was no error.

Returns:

Message Number

getMessageInsert

public String getMessageInsert()

This method returns a message insert for the message number returned by getMessageNumber.

Returns:

Message Insert, the return value can be an empty String but it is never null

getMessageText

public String getMessageText()

Returns the error message translated in the language of the user.

Returns:

Error message if the execution failed, the return value can be an empty String but it is never null