APIdia Launch Partner
Top Description Inners Methods
net.ucanaccess.commands

public Interface ICommand

Known Direct Subinterfaces
net.ucanaccess.commands.ICursorCommand
Known Direct Implementers
net.ucanaccess.commands.InsertCommand, net.ucanaccess.commands.AddColumnCommand, net.ucanaccess.commands.AlterRenameCommand, net.ucanaccess.commands.CompositeCommand, net.ucanaccess.commands.CreateForeignKeyCommand, net.ucanaccess.commands.CreateIndexCommand, net.ucanaccess.commands.CreatePrimaryKeyCommand, net.ucanaccess.commands.CreateTableCommand, net.ucanaccess.commands.DropForeignKeyCommand, net.ucanaccess.commands.DropTableCommand
Imports
java.sql.SQLException
Represents a database command that can be persisted to the Access file or rolled back.

This interface defines the contract for all data manipulation and definition operations within the UCanAccess command execution pipeline.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
ICommand.CommandType

Enumeration of supported command types.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the execution id
getExecId()

Returns the unique execution identifier.

public String

Returns:

the table name
getTableName()

Returns the name of the table affected by this command.

public ICommand.CommandType

Returns:

the command type
getType()

Returns the type of this command.

public IFeedbackAction

Returns:

a feedback action to be executed after persistence
persist()

Persists the changes to the underlying Access database file.

public IFeedbackAction

Returns:

a feedback action to be executed after rollback
rollback()

Reverts the changes made by this command.

public default String

Returns:

string representation
toIdentString()

Returns a string representation of the command.

Method Detail

getExecIdback to summary
public String getExecId()

Returns the unique execution identifier.

Returns:String

the execution id

getTableNameback to summary
public String getTableName()

Returns the name of the table affected by this command.

Returns:String

the table name

getTypeback to summary
public ICommand.CommandType getType()

Returns the type of this command.

Returns:ICommand.CommandType

the command type

persistback to summary
public IFeedbackAction persist() throws SQLException

Persists the changes to the underlying Access database file.

Returns:IFeedbackAction

a feedback action to be executed after persistence

Exceptions
SQLException:
if a database error occurs during persistence
rollbackback to summary
public IFeedbackAction rollback() throws SQLException

Reverts the changes made by this command.

Returns:IFeedbackAction

a feedback action to be executed after rollback

Exceptions
SQLException:
if a database error occurs during rollback
toIdentStringback to summary
public default String toIdentString()

Returns a string representation of the command.

Follows the format: ClassName[execId=id, type=type, table=tableName]

Returns:String

string representation

net.ucanaccess.commands back to summary

public final Enum ICommand.CommandType

extends Enum<ICommand.CommandType>
Class Inheritance
Enumeration of supported command types.

Field Summary

Modifier and TypeField and Description
public static final ICommand.CommandType
COMPOSITE

public static final ICommand.CommandType
DDL

public static final ICommand.CommandType
DELETE

public static final ICommand.CommandType
INSERT

public static final ICommand.CommandType
UPDATE

Constructor Summary

AccessConstructor and Description
private
CommandType()

Method Summary

Modifier and TypeMethod and Description
public static ICommand.CommandType
valueOf(String name)

public static ICommand.CommandType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

COMPOSITEback to summary
public static final ICommand.CommandType COMPOSITE
DDLback to summary
public static final ICommand.CommandType DDL
DELETEback to summary
public static final ICommand.CommandType DELETE
INSERTback to summary
public static final ICommand.CommandType INSERT
UPDATEback to summary
public static final ICommand.CommandType UPDATE

Constructor Detail

CommandTypeback to summary
private CommandType()

Method Detail

valueOfback to summary
public static ICommand.CommandType valueOf(String name)
valuesback to summary
public static ICommand.CommandType[] values()