ANNA Suite  2020b
Multipurpose development suite for Telco applications
Classes | Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
anna::dbms::ResultCode Class Reference

#include <ResultCode.hpp>

Inheritance diagram for anna::dbms::ResultCode:
Inheritance graph
[legend]

Classes

class  ErrorDecoder
 

Public Member Functions

 ResultCode ()
 
 ResultCode (const ResultCode &other)
 
virtual ~ResultCode ()
 
int getErrorCode () const
 
const char * getErrorText () const
 
ResultCodeoperator= (const ResultCode &resultCode)
 
bool notFound () const noexcept(false)
 
bool successful () const noexcept(false)
 
bool locked () const noexcept(false)
 
bool lostConnection () const noexcept(false)
 
std::string asString () const
 

Protected Member Functions

 ResultCode (const int errorCode, const char *errorText, const ErrorDecoder *errorDecoder)
 
void set (const int errorCode, const char *errorText)
 

Static Protected Attributes

static const int MaxErrorLen = 512
 

Detailed Description

Clase para acceder a la informacion devuelta por el gestor de base de datos referente al ultimo comando realizado.

Constructor & Destructor Documentation

◆ ResultCode() [1/3]

anna::dbms::ResultCode::ResultCode ( )
inline

Constructor vacio.

Warning
Antes de usarse debe asignarse a algun otro ResultCode obtenido mediante la invocacion a anna::dbms::Connection::execute.
36 : a_errorText(NULL), a_errorDecoder(NULL), a_errorCode(0) {;}

◆ ResultCode() [2/3]

anna::dbms::ResultCode::ResultCode ( const ResultCode other)
inline

Constructor copia.

Parameters
otherInstancia de la que copiar los datos.
42  :
43  a_errorText(NULL),
44  a_errorDecoder(other.a_errorDecoder) {
45  set(other.a_errorCode, other.a_errorText);
46  }

◆ ~ResultCode()

virtual anna::dbms::ResultCode::~ResultCode ( )
inlinevirtual

Destructor.

51 { if(a_errorText != NULL) free(a_errorText); }

◆ ResultCode() [3/3]

anna::dbms::ResultCode::ResultCode ( const int  errorCode,
const char *  errorText,
const ErrorDecoder errorDecoder 
)
inlineprotected

Constructor.

Parameters
errorCodeCodigo de error asociado a la ultima operacion realizada contra la base de datos.
errorTextTexto asociado al error de ultima operacion realizada contra la base de datos. Puede ser NULL si no hay ningun texto de error asociado al codigo recibido.
errorDecoderDecofidicador de errores.
142  :
143  a_errorText(NULL),
144  a_errorDecoder(errorDecoder) {
145  set(errorCode, errorText);
146  }

Member Function Documentation

◆ asString()

std::string anna::dbms::ResultCode::asString ( ) const

Devuelve una cadena con la informacion sobre esta clase.

Returns
Una cadena con la informacion sobre esta clase.

◆ getErrorCode()

int anna::dbms::ResultCode::getErrorCode ( ) const
inline

Devuelve el codigo de error del ultimo comando ejecutado contra la base de datos.

Returns
El codigo de error del ultimo comando ejecutado contra la base de datos.
57 { return a_errorCode; }

◆ getErrorText()

const char* anna::dbms::ResultCode::getErrorText ( ) const
inline

Devuelve el texto del error del ultimo comando ejecutado contra la base de datos.

Returns
El texto del error del ultimo comando ejecutado contra la base de datos.
63 { return (a_errorText != NULL) ? a_errorText : ""; }

◆ locked()

bool anna::dbms::ResultCode::locked ( ) const
noexcept

Devuelve true Si el registro obtenenido en una sentencia de seleccion con indicador de modo exclusivo ha sido bloqueada previamente por otro proceso y/o contexto de base de datos o false en otro caso.

Returns
true Si el registro obtenenido en una sentencia de seleccion con indicador de modo exclusivo ha sido bloqueada previamente por otro proceso y/o contexto de base de datos o false en otro caso.

◆ lostConnection()

bool anna::dbms::ResultCode::lostConnection ( ) const
noexcept

Devuelve true si se perdio la conexion la base de datos o false en otro caso.

Returns
true si se perdio la conexion la base de datos o false en otro caso.

◆ notFound()

bool anna::dbms::ResultCode::notFound ( ) const
noexcept

Devuelve true si las condiciones de busqueda de la ultimo operacion no han sido satisfechas por ningun registro o false en otro caso.

Returns
true si las condiciones de busqueda de la ultimo operacion no han sido satisfechas por ningun registro o false en otro caso.

◆ operator=()

ResultCode& anna::dbms::ResultCode::operator= ( const ResultCode resultCode)
inline

Operador copia.

Parameters
resultCodeInstancia a copiar.
Returns
Una instancia de si mismo.
72  {
73  if(this != &resultCode) {
74  a_errorDecoder = resultCode.a_errorDecoder;
75  set(resultCode.a_errorCode, resultCode.a_errorText);
76  }
77 
78  return *this;
79  }
Here is the call graph for this function:

◆ set()

void anna::dbms::ResultCode::set ( const int  errorCode,
const char *  errorText 
)
inlineprotected

Establece el contenido de esta clase.

Parameters
errorCodeCodigo de error asociado a la ultima operacion realizada contra la base de datos.
errorTextTexto asociado al error de ultima operacion realizada contra la base de datos.
155  {
156  a_errorCode = errorCode;
157  copy(errorText);
158  }

◆ successful()

bool anna::dbms::ResultCode::successful ( ) const
noexcept

Devuelve true si la ultima operacion solicitada fue realizada correctamente o false en otro caso.

Returns
true si la ultima operacion solicitada fue realizada correctamente o false en otro caso.

Member Data Documentation

◆ MaxErrorLen

const int anna::dbms::ResultCode::MaxErrorLen = 512
staticprotected

The documentation for this class was generated from the following file: