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

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

public class TTransactionTimeoutParameters
extends java.lang.Object

TTransactionTimeoutParameters is the collection of the timeout parameters used for the connection.

Version:
$Revision: 1.3 $
Author:
Stefan Liebig

Constructor Summary
TTransactionTimeoutParameters()
          Initializes the transactional parameters, so that it starts in default mode for all tamino transaction modes.
 
Method Summary
 long getMaximumTransactionDuration()
          Gets the maximum transaction duration in seconds.
 long getNonActivityTimeout()
          Gets the nonActivity timeout.
 boolean isGiven()
          Indicates if the transaction timeout parameters are still in its inital state.
 void reset()
          Resets the current tranaction timeout parameters.
 void setMaximumTransactionDuration(long maximumTransactionDuration)
          Sets the maximum transaction duration in seconds.
 void setNonActivityTimeout(long nonActivityTimeout)
          Sets the nonActivity timeout.
 java.lang.String toString()
          Writes the current transaction timeout parameters to a String.
 void writeTo(TCommandStatement commandStatement)
          Writes the current imeout parameters to the given commandStatement.
protected  void writeTo(TStreamHeader streamHeader)
          Writes the current timeout parameters to the given stream header.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TTransactionTimeoutParameters

public TTransactionTimeoutParameters()
Initializes the transactional parameters, so that it starts in default mode for all tamino transaction modes.

Method Detail

writeTo

public void writeTo(TCommandStatement commandStatement)
Writes the current imeout parameters to the given commandStatement.

Parameters:
commandStatement - gets the current timeout parameters.

writeTo

protected void writeTo(TStreamHeader streamHeader)
Writes the current timeout parameters to the given stream header. For plain url accesss it is neccessary to write the timeout parameters into the stream header.

Parameters:
streamHeader - gets the current timeout parameters.

setNonActivityTimeout

public void setNonActivityTimeout(long nonActivityTimeout)
Sets the nonActivity timeout.

Parameters:
nonActivityTimeout - the transaction nonActivity timeout be set, TConnection.DEFAULT_TIMEOUT for Tamino default.

getNonActivityTimeout

public long getNonActivityTimeout()
Gets the nonActivity timeout.

Returns:
the transaction nonActivity timeout. Returns DEFAUL_TIMEOUT, if no transaction nonActivity timeout is specified.

setMaximumTransactionDuration

public void setMaximumTransactionDuration(long maximumTransactionDuration)
Sets the maximum transaction duration in seconds.

Parameters:
maximumTransactionDuration - the maximum transaction duration in seconds in seconds be set, TConnection.DEFAULT_TIMEOUT for Tamino default.

getMaximumTransactionDuration

public long getMaximumTransactionDuration()
Gets the maximum transaction duration in seconds.

Returns:
the maximum transaction duration. Returns TConnection.DEFAULT_TIMEOUT, if no transaction timeout is specified.

isGiven

public boolean isGiven()
Indicates if the transaction timeout parameters are still in its inital state.

Returns:
true if the transaction timeout parameters are all in default, false otherwise.

toString

public java.lang.String toString()
Writes the current transaction timeout parameters to a String.

Overrides:
toString in class java.lang.Object
Returns:
the transaction timeout parameters as a String.

reset

public void reset()
Resets the current tranaction timeout parameters.



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