Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_iTx_Cmd interface

• Introduction

Transaction command interface.

• Interface synopsis

AMI_iTx_Cmd {
/* Constants */
// Skip existing target command entity
const AMI_iTx_Cmd::MODE_APPEND =  0x01;
// If target command entity exists exception will be thrown
const AMI_iTx_Cmd::MODE_COMMON =  0x00;
// Delete backup on commit
const AMI_iTx_Cmd::MODE_DELETE_BACKUP_ON_COMMIT =  0x80;
// Ignore data existence
const AMI_iTx_Cmd::MODE_IGNORE_DATA_EXISTENCE =  0x20;
// Ignore target existence
const AMI_iTx_Cmd::MODE_IGNORE_TARGET_EXISTENCE =  0x10;
// Overwrite existing target command entity
const AMI_iTx_Cmd::MODE_OVERWRITE =  0x02;
// Uninstallation mode deleting data and local code
const AMI_iTx_Cmd::MODE_PURGE =  0x08;
// Uninstallation mode allows to keep data and local code
const AMI_iTx_Cmd::MODE_SOFT =  0x04;
/* Methods */
// Commits command.
public commit ( ) returns void;
// Returns string containing argements for logging.
public getLoggingArgs ( ) returns string;
// Rollbacks command.
public rollback ( ) returns void;
}
Tags:
since 6.0.2

• Interface Constants

MODE_APPEND

Skip existing target command entity

Command mode.

MODE_COMMON

If target command entity exists exception will be thrown

Command mode.

MODE_DELETE_BACKUP_ON_COMMIT

Delete backup on commit

Command mode.

MODE_IGNORE_DATA_EXISTENCE

Ignore data existence

Command mode.

MODE_IGNORE_TARGET_EXISTENCE

Ignore target existence

Command mode.

MODE_OVERWRITE

Overwrite existing target command entity

Command mode.

MODE_PURGE

Uninstallation mode deleting data and local code

Command mode.

MODE_SOFT

Uninstallation mode allows to keep data and local code

Command mode.

• Interface Methods

// Commits command.
public commit ( ) returns void;
Called after all commands finished successfully.
// Returns string containing argements for logging.
public getLoggingArgs ( ) returns string;
// Rollbacks command.
public rollback ( ) returns void;
Called on transaction exception cought.