com.softwareag.tamino.db.api.command
Class TCommandParameter

java.lang.Object
  extended by com.softwareag.tamino.db.api.command.TCommandItem
      extended by com.softwareag.tamino.db.api.command.TCommandParameter

public final class TCommandParameter
extends TCommandItem

Class representing Tamino specific command verb parameters. The class provides type safe constant objects representing the various parameters which currently only refer to session handling.

Version:
$Revision: 1.21 $
Author:
Marcus Schreyer

Field Summary
static TCommandParameter CLIENTREQUESTID
          Constant that represents the "_clientRequestId" command parameter.
static TCommandParameter COLLECTION
          Constant that represents the "_collection" command parameter.
static TCommandParameter COUNT
          Constant that represents the "_count" command parameter.
static TCommandParameter DOCTYPE
          Constant that represents the "_doctype" command parameter.
static TCommandParameter DOCUMENT
          Constant that represents the "_document" command parameter.
static TCommandParameter DURATION
          Constant that represents the "_duration" command parameter.
static TCommandParameter GROUPS
          Constant that represents the "_groups" command parameter.
static TCommandParameter HANDLE
          Constant that represents the "_handle" command parameter.
static TCommandParameter ISOLATION_DEGREE
          Constant that represents the "_isolationLevel" command parameter.
static TCommandParameter ISOLATION_LEVEL
          Constant that represents the "_isolation" command parameter.
static TCommandParameter LOCK_MODE
          Constant that represents the "_lockMode" command parameter.
static TCommandParameter LOCKWAIT_MODE
          Constant that represents the "_lockwait" command parameter.
static TCommandParameter MAXIMUMREQUESTDURATION
          Constant that represents the "_maximumrequestduration" command parameter.
static TCommandParameter MODE
          Constant that represents the "_mode" command parameter.
static TCommandParameter NON_ACTIVITY_TIMEOUT
          Constant that represents the "_nonActivityTimeout" command parameter.
static TCommandParameter ON_2PC_COMPLETION
          Constant that represents the "_on2PCCompletion" command parameter.
static TCommandParameter POSITION
          Constant that represents the "_position" command parameter.
static TCommandParameter QUANTITY
          Constant that represents the "_quantity" command parameter.
static TCommandParameter QUERYSEARCHMODE
          Constant that represents the "_querysearchmode" command parameter.
static TCommandParameter SCROLL
          Constant that represents the "_scroll" command parameter.
static TCommandParameter SENSITIVE
          Constant that represents the "_sensitivity" command parameter.
static TCommandParameter SESSION_ID
          Constant that represents the "_sessionid" command parameter.
static TCommandParameter SESSION_KEY
          Constant that represents the "_sessionkey" command parameter.
static TCommandParameter TIP_TRANSACTION
          Constant that represents the "_TIPTransaction" command parameter.
static TCommandParameter TRANSACTION_TIMEOUT
          Constant that represents the "_transactionTimeout" command parameter.
static TCommandParameter UTX_TRANSACTION
          Constant that represents the "_UTXTransaction" command parameter.
 
Method Summary
 void takeVisitor(TCommandItemVisitor visitor)
          Takes a TCommandItemVisitor and tells it that it wants to be visited.
 
Methods inherited from class com.softwareag.tamino.db.api.command.TCommandItem
getValue, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SESSION_ID

public static final TCommandParameter SESSION_ID
Constant that represents the "_sessionid" command parameter.


SESSION_KEY

public static final TCommandParameter SESSION_KEY
Constant that represents the "_sessionkey" command parameter.


ISOLATION_LEVEL

public static final TCommandParameter ISOLATION_LEVEL
Constant that represents the "_isolation" command parameter.


LOCKWAIT_MODE

public static final TCommandParameter LOCKWAIT_MODE
Constant that represents the "_lockwait" command parameter.


ISOLATION_DEGREE

public static final TCommandParameter ISOLATION_DEGREE
Constant that represents the "_isolationLevel" command parameter.


LOCK_MODE

public static final TCommandParameter LOCK_MODE
Constant that represents the "_lockMode" command parameter.


NON_ACTIVITY_TIMEOUT

public static final TCommandParameter NON_ACTIVITY_TIMEOUT
Constant that represents the "_nonActivityTimeout" command parameter.


TRANSACTION_TIMEOUT

public static final TCommandParameter TRANSACTION_TIMEOUT
Constant that represents the "_transactionTimeout" command parameter.


DOCTYPE

public static final TCommandParameter DOCTYPE
Constant that represents the "_doctype" command parameter.


DOCUMENT

public static final TCommandParameter DOCUMENT
Constant that represents the "_document" command parameter.


MODE

public static final TCommandParameter MODE
Constant that represents the "_mode" command parameter. Values:


SCROLL

public static final TCommandParameter SCROLL
Constant that represents the "_scroll" command parameter. Values: , Default:


HANDLE

public static final TCommandParameter HANDLE
Constant that represents the "_handle" command parameter.


SENSITIVE

public static final TCommandParameter SENSITIVE
Constant that represents the "_sensitivity" command parameter.


POSITION

public static final TCommandParameter POSITION
Constant that represents the "_position" command parameter. Note: The position of the first cursor result is 1.


QUANTITY

public static final TCommandParameter QUANTITY
Constant that represents the "_quantity" command parameter. Note: Quantity has an implementation-defined default. Quantity=0 is supported � it can be used for checking the status of the cursor.


COUNT

public static final TCommandParameter COUNT
Constant that represents the "_count" command parameter.


TIP_TRANSACTION

public static final TCommandParameter TIP_TRANSACTION
Constant that represents the "_TIPTransaction" command parameter.


UTX_TRANSACTION

public static final TCommandParameter UTX_TRANSACTION
Constant that represents the "_UTXTransaction" command parameter.


ON_2PC_COMPLETION

public static final TCommandParameter ON_2PC_COMPLETION
Constant that represents the "_on2PCCompletion" command parameter.


DURATION

public static final TCommandParameter DURATION
Constant that represents the "_duration" command parameter.


COLLECTION

public static final TCommandParameter COLLECTION
Constant that represents the "_collection" command parameter.


MAXIMUMREQUESTDURATION

public static final TCommandParameter MAXIMUMREQUESTDURATION
Constant that represents the "_maximumrequestduration" command parameter.


CLIENTREQUESTID

public static final TCommandParameter CLIENTREQUESTID
Constant that represents the "_clientRequestId" command parameter. Note that this parameter is not understandable by Server. It is for internal use within API.


QUERYSEARCHMODE

public static final TCommandParameter QUERYSEARCHMODE
Constant that represents the "_querysearchmode" command parameter. Note that this parameter is to be used with query commands only.


GROUPS

public static final TCommandParameter GROUPS
Constant that represents the "_groups" command parameter. Note that this parameter is to be used with _connect only.

Method Detail

takeVisitor

public void takeVisitor(TCommandItemVisitor visitor)
Takes a TCommandItemVisitor and tells it that it wants to be visited.

Specified by:
takeVisitor in class TCommandItem
Parameters:
the - TCommandItemVisitor that shall visit this instance.


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