com.mycompany.myproject.api
Class MyFunction.SuccessfulResult

java.lang.Object
  extended byorg.xins.server.FunctionResult
      extended bycom.mycompany.myproject.api.MyFunction.SuccessfulResult
All Implemented Interfaces:
MyFunction.Result, Serializable
Enclosing class:
MyFunction

public static final class MyFunction.SuccessfulResult
extends FunctionResult
implements MyFunction.Result

Successful result of a call to the MyFunction function.

See Also:
Serialized Form

Constructor Summary
MyFunction.SuccessfulResult()
          Creates a new SuccessfulResult object.
 
Method Summary
 InvalidResponseResult checkOutputParameters()
           
 String getMessage()
          Gets the value of the required output parameter message.
 void setMessage(String message)
          Sets the value of the required output parameter message.
 
Methods inherited from class org.xins.server.FunctionResult
add, getDataElement, getErrorCode, getParameter, getParameters, param, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MyFunction.SuccessfulResult

public MyFunction.SuccessfulResult()
Creates a new SuccessfulResult object.

Method Detail

setMessage

public void setMessage(String message)
Sets the value of the required output parameter message. This method has to be called before returning the SuccessfulResult.

Parameters:
message - the value of the required output parameter message, can be null. The value is not added to the result if the value is null or its String representation is an empty String.

getMessage

public String getMessage()
Gets the value of the required output parameter message. If unset, null is returned.

Returns:
the value of the required output parameter message, or null if unset.

checkOutputParameters

public InvalidResponseResult checkOutputParameters()