Package com.uc4.communication.requests

Class ExecuteObjects.ExecuteObjectsResponse

  • Enclosing class:
    ExecuteObjects
    public class ExecuteObjects.ExecuteObjectsResponse
extends java.lang.Object
    Class hold response data from the executed request

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ExecuteObjectsResponse​(int runId, int messageNumber, java.lang.String messageInsert, java.lang.String messageText)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.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.
      java.lang.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 Detail

      • ExecuteObjectsResponse

        protected ExecuteObjectsResponse​(int runId,
                                 int messageNumber,
                                 java.lang.String messageInsert,
                                 java.lang.String messageText)

    • Method Detail

      • 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 java.lang.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 java.lang.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