IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.services
Interface Poolable

All Known Implementing Classes:
JDBCTableServiceImpl, PoolableServiceImpl

public interface Poolable

The Poolable interface must be implemented by the objects that use the GenericPool service.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.String getGrantTime()
          Returns the grant time of the pool object.
 boolean getInUse()
          Returns the inUse attribute.
 java.lang.String getUID()
          Set UID to the pool instance.
 void initialize()
          Performs some required actions before begining.
 void reset()
          Resets the pool.
 void setGrantTime(java.lang.String string)
          Set the grant time of the pool object.
 void setInUse(boolean b)
          Sets the value of the inUse attribute.
 void setUID(java.lang.String uid)
          Set UID to the pool instance.
 void terminate()
          Performs some required actions before finishing.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getGrantTime

public java.lang.String getGrantTime()
Returns the grant time of the pool object.

Returns:
String - the grant time of the pool object.

setGrantTime

public void setGrantTime(java.lang.String string)
Set the grant time of the pool object.

Parameters:
string - - the grant time of the pool object.

getInUse

public boolean getInUse()
Returns the inUse attribute.

Returns:
boolean - Returns true if the object is in use

initialize

public void initialize()
                throws DSEException
Performs some required actions before begining.

Throws:
DSEException
DSEException

reset

public void reset()
           throws DSEException
Resets the pool. This method is invoked when releasing the Poolable object

Throws:
DSEException
DSEException

setInUse

public void setInUse(boolean b)
Sets the value of the inUse attribute.

Parameters:
b - The value of the attribute

terminate

public void terminate()
               throws DSEException
Performs some required actions before finishing.

Throws:
DSEException
DSEException

setUID

public void setUID(java.lang.String uid)
Set UID to the pool instance.

Throws:
DSEException

getUID

public java.lang.String getUID()
Set UID to the pool instance.

Throws:
DSEException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005