com.softwareag.tamino.db.api.connection
Class TLockwaitMode

java.lang.Object
  extended by com.softwareag.tamino.db.api.connection.TLockwaitMode

public final class TLockwaitMode
extends java.lang.Object

Class representing Tamino specific lockwait modes. The class provides type safe constant objects representing the possible settings for the lockwait session parameter available for Tamino. The lockwait mode correponds to the _lockwait session parameter of Tamino.

The lockwait mode specifies which action Tamino is to take if a document is currently not accessible because another transaction has a lock on that document that prevents it from being made available. Tamino can either wait until the lock is released or return to the caller immediately with an exception.

Please refer to the description of the Transaction-Related Commands in the Tamino Server documentation for details on the usage of this parameter.

Version:
$Revision: 1.9 $
Author:
Marcus Schreyer

Field Summary
static TLockwaitMode NO
          Constant that represents the "lockwait no" Lockwait mode.
static TLockwaitMode YES
          Constant that represents the "lockwait yes" Lockwait mode.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is "equal to" this one.
 int hashCode()
          Returns a hash code value for the object.
 java.lang.String toString()
          Returns the string representation of a TLockwaitMode object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

YES

public static final TLockwaitMode YES
Constant that represents the "lockwait yes" Lockwait mode. If this mode is set, Tamino will wait until all locks preventing the required document to be made available have been released.


NO

public static final TLockwaitMode NO
Constant that represents the "lockwait no" Lockwait mode. If this mode is set, Tamino will immediately return to the caller if any lock is detected preventing the required document to bve made available. In this case, a TQueryException exception is thrown. This TQueryException instance contains a TAcccessFailureMessage, which in turn contains the return value 9155 as a string.

Method Detail

toString

public java.lang.String toString()
Returns the string representation of a TLockwaitMode object.

Overrides:
toString in class java.lang.Object
Returns:
the string representation of the lockwait mode.

equals

public boolean equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one. Overrides the Object.equals method.

Overrides:
equals in class java.lang.Object
Parameters:
obj - - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. Overrides the Object.hashCode method.

Overrides:
hashCode in class java.lang.Object
Returns:
a hash code value for this object.


Copyright (c) 2013 Software AG. All Rights Reserved.