com.softwareag.tamino.db.api.accessor
Interface TAccessor

All Superinterfaces:
TInvalidatableAccessor
All Known Subinterfaces:
TAdministrationAccessor, TGenericAccessor, TNonXMLObjectAccessor, TSchemaDefinition2Accessor, TSchemaDefinition3Accessor, TStreamAccessor, TSystemAccessor, TXMLObjectAccessor
All Known Implementing Classes:
TAbstractAccessor, TAbstractSchemaDefinitionAccessor, TAdministrationAccessorImpl, TAdministrationAccessorTimeLoggingImpl, TGenericAccessorImpl, TGenericAccessorTimeLoggingImpl, TNonXMLObjectAccessorImpl, TNonXMLObjectAccessorTimeLoggingImpl, TSchemaDefinition2AccessorImpl, TSchemaDefinition2AccessorTimeLoggingImpl, TSchemaDefinition3AccessorImpl, TSchemaDefinition3AccessorTimeLoggingImpl, TStreamAccessorImpl, TStreamAccessorTimeLoggingImpl, TSystemAccessorImpl, TSystemAccessorTimeLoggingImpl, TXMLObjectAccessorImpl, TXMLObjectAccessorTimeLoggingImpl

public interface TAccessor
extends TInvalidatableAccessor

TAccessor is the super interface of specialized accessor interfaces, like TXMLObjectAccessor and TNonXMLObjectAccessor. The TAccessor interface describes methods common to all accessors.

Version:
$Revision: 1.18 $
Author:
Marcus Schreyer

Method Summary
 void cancelRequests()
          Cancels all requests issued using current accessor.
 TAccessLocation getAccessLocation()
          Returns a deep copy of the accessor's location.
 java.lang.String getApplicationName()
          Returns Client Application Name.
 boolean getCanBeCancelled()
          Returns true if request can be canceled.
 TLockMode getLockMode()
          Gets the lock mode.
 TLockwaitMode getLockwaitMode()
          Gets the current lockwait mode.
 long getMaximumRequestDuration()
          Gets the maximum request duration in seconds.

Note:
This method retrieves the servers default value, when this duration has not been set to a specific value (unequal to TConnection.DEFAULT_TIMEOUT)!
 void setAccessLocation(TAccessLocation accessLocation)
          Sets the accessor's location to be used by the accessor.
 void setApplicationName(java.lang.String name)
          Sets Client Application Name.
 void setCanBeCancelled(boolean canBeCancelled)
          Sets whether request can be canBeCancelled.
 void setLockMode(TLockMode lockMode)
          Sets the lock mode an acccess.
 void setLockwaitMode(TLockwaitMode lockwaitMode)
          Sets the lockwait mode for an acccess.
 void setMaximumRequestDuration(long maximumRequestDuration)
          Sets the maximum request duration in seconds.
 
Methods inherited from interface com.softwareag.tamino.db.api.accessor.TInvalidatableAccessor
invalidate
 

Method Detail

setAccessLocation

void setAccessLocation(TAccessLocation accessLocation)
Sets the accessor's location to be used by the accessor.

Parameters:
accessLocation - the TAccessLocation instance to be used by the accessor.

getAccessLocation

TAccessLocation getAccessLocation()
Returns a deep copy of the accessor's location.

Returns:
a copy of the TAccessLocation instance.

setLockwaitMode

void setLockwaitMode(TLockwaitMode lockwaitMode)
Sets the lockwait mode for an acccess.

Parameters:
lockwaitMode - the lockwait mode to be set, 'null' for Tamino default.

getLockwaitMode

TLockwaitMode getLockwaitMode()
Gets the current lockwait mode. A 'null' value represents the Tamino default.

Returns:
the lockwait mode. Returns 'null' if no lockwait mode is specified.

setLockMode

void setLockMode(TLockMode lockMode)
Sets the lock mode an acccess.

Parameters:
lockMode - the lock mode to be set, 'null' for Tamino default.

getLockMode

TLockMode getLockMode()
Gets the lock mode. A 'null' value represents the Tamino default.

Returns:
the lock mode. Returns 'null' if no lock mode is specified.

setMaximumRequestDuration

void setMaximumRequestDuration(long maximumRequestDuration)
Sets the maximum request duration in seconds.
Note that for pooled connections obtained frlom a connection pool which configured to pool Tamino physical connections, the invocation of this method has no effect. The default value is set once and for all for all connections in a pool when the pool is created.

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

getMaximumRequestDuration

long getMaximumRequestDuration()
Gets the maximum request duration in seconds.

Note:
This method retrieves the servers default value, when this duration has not been set to a specific value (unequal to TConnection.DEFAULT_TIMEOUT)!

Returns:
the maximum transaction duration in seconds.

setCanBeCancelled

void setCanBeCancelled(boolean canBeCancelled)
                       throws TAdminException
Sets whether request can be canBeCancelled.

Throws:
TAdminException

getCanBeCancelled

boolean getCanBeCancelled()
Returns true if request can be canceled.


setApplicationName

void setApplicationName(java.lang.String name)
Sets Client Application Name.


getApplicationName

java.lang.String getApplicationName()
Returns Client Application Name. Default value is - "TAJ" {Tamino API for Java}


cancelRequests

void cancelRequests()
                    throws TAdminException
Cancels all requests issued using current accessor.

Throws:
TAdminException


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