com.bigllc.retsiq.simpleclient
Class UpdateWarning

java.lang.Object
  extended by com.bigllc.retsiq.simpleclient.UpdateWarning

public class UpdateWarning
extends java.lang.Object

Update warning bean. Supplies field warning information from failed update transactions.

Author:
Marc G. Smith

Nested Class Summary
static class UpdateWarning.ResponseRequired
          The response type required.
 
Method Summary
 int getCode()
          Get the warning code associated with the warning.
 java.lang.String getField()
          Get the field that the error applies to.
 int getOffset()
          Get the offset of the error.
 UpdateWarning.ResponseRequired getResponseRequired()
          Get the type of response required for this warning.
 java.lang.String getText()
          Get the description associated with the warning.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getText

public java.lang.String getText()
Get the description associated with the warning.

Returns:
the warning description.

getCode

public int getCode()
Get the warning code associated with the warning.

Returns:
the warning code.

getField

public java.lang.String getField()
Get the field that the error applies to.

Returns:
the field name.

getOffset

public int getOffset()
Get the offset of the error.

Returns:
the offset

getResponseRequired

public UpdateWarning.ResponseRequired getResponseRequired()
Get the type of response required for this warning. The value indicates whether an end-user response is requested or required: If the response required field indicates that a response is mandatory, the client MUST send the end-user response for the specific warning-num in the WarningResponse request argument in order for this record to be saved to the database.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object