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

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

public final class TCommand
extends TCommandItem

Class representing Tamino specific command verbs. The class provides, by implementing type safe enum pattern, constant objects representing the various command verbs such as _process, _delete, _define etc. for Tamino.

Version:
$Revision: 1.19 $
Author:
Marcus Schreyer

Field Summary
static TCommand ADMIN
          Constant that represents the "_admin" command verb.
static TCommand COMMIT
          Constant that represents the "_commit" command verb Commit a transaction
static TCommand CONNECT
          Constant that represents the "_connect" command verb Start a database session
static TCommand CURSOR
          Constant that represents the "_cursor" command verb Open a cursor
static TCommand DEFINE
          Constant that represents the "_define" command verb Create a collection or schema; modify an existing schema
static TCommand DELETE
          Constant that represents the "_delete" command verb Delete one or more objects
static TCommand DESTROY
          Constant that represents the "_destroy" command verb Remove a Prepared Query
static TCommand DIAGNOSE
          Constant that represents the "_diagnose" command verb Perform a diagnostic test
static TCommand DISCONNECT
          Constant that represents the "_disconnect" command verb Terminate a database session
static TCommand ENLIST_2PC
          Constant that represents the "_enlist2PC" command verb
static TCommand EXECUTE
          Constant that represents the "_execute" command verb
static TCommand PREPARE
          Constant that represents the "_prepare" command verb
static TCommand PROCESS
          Constant that represents the "_process" command verb Store one or more objects into a collection; or modify an existing XML object
static TCommand RETRIEVE
          Constant that represents the "_retrieve" command verb, which is only used internaly to generate a TCommandStatement that can carry additional parameters.
static TCommand RETRIEVE_HEAD
          Constant that represents the "_retrieveHead" command verb, which is only used internaly to generate a TCommandStatement that can carry additional parameters.
static TCommand ROLLBACK
          Constant that represents the "_rollback" command verb Roll back a transaction
static TCommand UNDEFINE
          Constant that represents the "_undefine" command verb Delete a collection or schema
static TCommand XQL
          Constant that represents the "_xql" command verb Retrieve one or more objects using the X-Machine query language
static TCommand XQUERY
          Constant that represents the "_xquery" command verb
 
Method Summary
protected  boolean isFake()
          Is it an fake command - not directly usable with Tamino.
 boolean needsNoEffortOnObjectContent()
          Does the request for this command needs the interpreter in case the object content header exist?
 boolean needsNoEffortOnOk()
          Does the request for this command needs the interpreter in case the X-INO-ReturnValue exists and is "0"?
static TCommand newCommand(java.lang.String value)
           
 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

ADMIN

public static final TCommand ADMIN
Constant that represents the "_admin" command verb. Perform an administration function.


DIAGNOSE

public static final TCommand DIAGNOSE
Constant that represents the "_diagnose" command verb Perform a diagnostic test


DESTROY

public static final TCommand DESTROY
Constant that represents the "_destroy" command verb Remove a Prepared Query


PROCESS

public static final TCommand PROCESS
Constant that represents the "_process" command verb Store one or more objects into a collection; or modify an existing XML object


DELETE

public static final TCommand DELETE
Constant that represents the "_delete" command verb Delete one or more objects


DEFINE

public static final TCommand DEFINE
Constant that represents the "_define" command verb Create a collection or schema; modify an existing schema


UNDEFINE

public static final TCommand UNDEFINE
Constant that represents the "_undefine" command verb Delete a collection or schema


XQL

public static final TCommand XQL
Constant that represents the "_xql" command verb Retrieve one or more objects using the X-Machine query language


CONNECT

public static final TCommand CONNECT
Constant that represents the "_connect" command verb Start a database session


DISCONNECT

public static final TCommand DISCONNECT
Constant that represents the "_disconnect" command verb Terminate a database session


COMMIT

public static final TCommand COMMIT
Constant that represents the "_commit" command verb Commit a transaction


ROLLBACK

public static final TCommand ROLLBACK
Constant that represents the "_rollback" command verb Roll back a transaction


CURSOR

public static final TCommand CURSOR
Constant that represents the "_cursor" command verb Open a cursor


XQUERY

public static final TCommand XQUERY
Constant that represents the "_xquery" command verb


PREPARE

public static final TCommand PREPARE
Constant that represents the "_prepare" command verb


EXECUTE

public static final TCommand EXECUTE
Constant that represents the "_execute" command verb


ENLIST_2PC

public static final TCommand ENLIST_2PC
Constant that represents the "_enlist2PC" command verb


RETRIEVE

public static final TCommand RETRIEVE
Constant that represents the "_retrieve" command verb, which is only used internaly to generate a TCommandStatement that can carry additional parameters. It can never be sent to Tamino!! This command will issue an HTTP GET request.


RETRIEVE_HEAD

public static final TCommand RETRIEVE_HEAD
Constant that represents the "_retrieveHead" command verb, which is only used internaly to generate a TCommandStatement that can carry additional parameters. It can never be sent to Tamino!! This command will issue an HTTP HEAD request.

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.

newCommand

public static TCommand newCommand(java.lang.String value)

isFake

protected boolean isFake()
Is it an fake command - not directly usable with Tamino.

Returns:
the fake flag

needsNoEffortOnOk

public boolean needsNoEffortOnOk()
Does the request for this command needs the interpreter in case the X-INO-ReturnValue exists and is "0"?

Returns:
obvious

needsNoEffortOnObjectContent

public boolean needsNoEffortOnObjectContent()
Does the request for this command needs the interpreter in case the object content header exist?

Returns:
obvious


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