com.genesyslab.omsdk.mil
Interface MILESPFaultResponse

All Superinterfaces:
MILESPResponse

public interface MILESPFaultResponse
extends MILESPResponse

Represents a fault response.

Send this fault response to the Interaction Server as the result of processing an ESP request.

To get a MILESPFaultResponse object, call the MILESPRequest.createFaultResponse() method, as shown in the following code snippet.

MILESPFaultResponse faultResponse = myMILESPRequest.createFaultResponse();

The created response is associated with the request from which it was created.

Set parameters describing the fault response, as shown here:

//Setting fault parameters describing a database error

//In this example, DATABASE_ERROR_CODE = 53
faultResponse.setFaultCode(DATABASE_ERROR_CODE) ;

//In this example, DATABASE_ERROR_MSG = "Error occurred when updating database"
faultResponse.setFaultString(DATABASE_ERROR_MSG) ;

To send this response, call the inherited send() method as shown here:

//Sending the response
faultResponse.send() ;

Since:
7.1.008.00
See Also:
MILESPRequest, MILESPExtension

Method Summary
 int getFaultCode()
          Deprecated. as of 7.2.007.00. Please use getFaultCodeString() insted
 java.lang.String getFaultCodeString()
          Gets user-defined error code.
 java.lang.String getFaultString()
          Returns the user-defined fault string for this response.
 void setFaultCode(int faultCode)
          Deprecated. as of 7.2.007.00. Please use setFaultCode(String) insted
 void setFaultCode(java.lang.String faultCode)
          Sets the user-defined error code.
 void setFaultString(java.lang.String faultString)
          Sets the user-defined fault string for this response.
 
Methods inherited from interface com.genesyslab.omsdk.mil.MILESPResponse
send
 

Method Detail

setFaultString

public void setFaultString(java.lang.String faultString)
Sets the user-defined fault string for this response.

Note: Sets this string before sending the response.

Parameters:
faultString - User-defined fault reason.

getFaultString

public java.lang.String getFaultString()
Returns the user-defined fault string for this response.

Returns:
user-defined fault string

setFaultCode

public void setFaultCode(int faultCode)
Deprecated. as of 7.2.007.00. Please use setFaultCode(String) insted

Sets the user-defined error code.

Parameters:
faultCode - user-defined error code.

setFaultCode

public void setFaultCode(java.lang.String faultCode)
Sets the user-defined error code.

Parameters:
faultCode - user-defined error code.

getFaultCode

public int getFaultCode()
Deprecated. as of 7.2.007.00. Please use getFaultCodeString() insted

Gets user-defined error code.

Returns:
user-defined error code.

getFaultCodeString

public java.lang.String getFaultCodeString()
Gets user-defined error code.

Returns:
user-defined error code.