be.SIRAPRISE.client.jsba

Class DmlCommand

java.lang.Object

be.SIRAPRISE.client.jsba.DmlCommand

Direct Known Subclasses:

DmlAssignmentCommand, DmlNonAssignmentCommand

public abstract class DmlCommand
extends java.lang.Object

DmlCommand objects are the objects that represent dml Commands that can be executed in a transaction, on a connection to a SIRA_PRISE database. DmlCommand objects are,in a sense, at a higher level of abstraction since they are meant to be used in connection with the jsba package's DBObjects. The client package's ServerCommand class of objects, otoh, is more at the "lower" level of the commands that are actually sent acros the line to the server.

Author:

Erwin Smout

Constructor Summary

Constructors

Constructor and Description
DmlCommand()

Method Summary

Modifier and Type	Method and Description
static Relation	execDmlCommand(DBTransaction transaction, DmlCommand command) Sends a command to the server and returns the result obtained.
static Relation	execDmlCommandAndEndTransaction(DBTransaction dbTransaction, DmlCommand command) Sends a command to the server and returns the result obtained.
abstract java.lang.String	getCommand() Gets the command text
abstract ServerCommand	getServerCommand() Gets the ServerCommand object representing this dml command
abstract void	success() Invoked after successfull execution.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DmlCommand

public DmlCommand()

Method Detail

getCommand

public abstract java.lang.String getCommand()

Gets the command text

Returns:

the command text

getServerCommand

public abstract ServerCommand getServerCommand()

Gets the ServerCommand object representing this dml command

Returns:

the ServerCommand object representing this dml command

success

public abstract void success()

Invoked after successfull execution.

execDmlCommand

public static final Relation execDmlCommand(DBTransaction transaction,
                                            DmlCommand command)
                                     throws ConnectionClosedException,
                                            ErrorMessageException

Sends a command to the server and returns the result obtained.

Parameters:

transaction - The transaction in which to execute the command

command - the command to be executed, in textual form.

Returns:

the result of the command.

Throws:

ConnectionClosedException - If the connection was closed due to an I/O error that occurred during communication with the server

ErrorMessageException - If the response obtained from the server is not a commit confirmation, but an error response instead.

execDmlCommandAndEndTransaction

public static final Relation execDmlCommandAndEndTransaction(DBTransaction dbTransaction,
                                                             DmlCommand command)
                                                      throws ConnectionClosedException,
                                                             ErrorMessageException

Sends a command to the server and returns the result obtained.

Parameters:

dbTransaction - The transaction in which to execute the given DML command

command - the command to be executed, in textual form.

Returns:

the result of the command.

Throws:

ConnectionClosedException - If the connection was closed due to an I/O error that occurred during communication with the server

ErrorMessageException - If the response obtained from the server is not a commit confirmation, but an error response instead.