com.bigllc.retsiq.simpleclient
Class UpdateResponse

java.lang.Object
  com.bigllc.retsiq.simpleclient.UpdateResponse

public class UpdateResponse
extends java.lang.Object

Update response bean. Supplies response information from update transaction such as field errors and the returned record.

Author:

Marc G. Smith

Method Summary

java.util.List<UpdateError>	getErrors() If any field errors were returned then the list will contain all the errors returned from the server.
java.lang.String	getLockKey() Get the lock key if one was returned by the server, for use with other update and post object transactions.
java.lang.Integer	getLockTime() Get the lock time if one was returned by the server.
int	getResponseCode() Get the response code returned by the server.
java.lang.String	getResponseText() Get the response text returned by the server.
java.util.Map<java.lang.String,java.lang.String>	getReturnedRecord() Get a map with the returned record from the server.
java.lang.String	getTransactionId() Get the transaction id if available.
boolean	getUpdateSuccess() Check if the response code from the server was operational successful.
java.util.List<UpdateWarning>	getWarnings() If any field warnings were returned then the list will contain all the warnings returned from the server.

Methods inherited from class java.lang.Object

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

Method Detail

getTransactionId

public java.lang.String getTransactionId()

Get the transaction id if available.

Returns:

the transaction id

getLockTime

public java.lang.Integer getLockTime()

Get the lock time if one was returned by the server.

Returns:

the lock time in seconds set by the server

getLockKey

public java.lang.String getLockKey()

Get the lock key if one was returned by the server, for use with other update and post object transactions.

Returns:

the lock key.

getReturnedRecord

public java.util.Map<java.lang.String,java.lang.String> getReturnedRecord()

Get a map with the returned record from the server. The map contains a column name for the key and the field value as the related entry.

Returns:

the record returned from the server.

getErrors

public java.util.List<UpdateError> getErrors()

If any field errors were returned then the list will contain all the errors returned from the server. The return value will be an empty list of no errors were reported. There is no need to check for a null list.

Returns:

a list containing any update field errors or an empty list if successful or no errors were returned.

getWarnings

public java.util.List<UpdateWarning> getWarnings()

If any field warnings were returned then the list will contain all the warnings returned from the server. The return value will be an empty list of no warnings were reported. There is no need to check for a null list.

Returns:

a list containing any update field warnings or an empty list if successful or no warnings were returned.

getUpdateSuccess

public boolean getUpdateSuccess()

Check if the response code from the server was operational successful.

Returns:

true if response code was successful, false otherwise.

getResponseCode

public int getResponseCode()

Get the response code returned by the server. Note that the response code will either be 0 for successful or 20301 for invalid parameter. All other errors are reported via an exception thrown by the update method on RETSSessionUser.update().

Returns:

a RETS response code.

See Also:

RETSUserSession.update(String, Map, int)

getResponseText

public java.lang.String getResponseText()

Get the response text returned by the server.

Returns:

the RETS response text .