LibreDTE

ExchangeStatus
in package
implements ExchangeStatusInterface

Clase que representa el estado del resultado de la ejecución de una estrategia de intercambio.

Table of Contents

Interfaces

ExchangeStatusInterface
Interfaz para el estado del resultado de una estrategia de intercambio de un sobre específico.

Properties

$error  : Throwable|null
El error que la estrategia generó al ser ejecutada.
$metadata  : BagInterface
Metadatos del estado de resultado.
$strategy  : string
Código de la estrategia a la que está asociado este estado.

Methods

__construct()  : mixed
Constructor del estado de la estrategia.
addMetadata()  : static
Agrega una clave específica a los metadatos.
getError()  : Throwable|null
Entrega el error o excepción que se generó al procesar el sobre.
getMetadata()  : BagInterface
Obtiene los metadatos del estado del resultado.
getStrategy()  : string
Entrega el código de la estrategia que generó este estado de intercambio de un sobre.
hasError()  : bool
Indica si el estado tiene un error.
isOk()  : bool
Indica si el estado del resultado de la ejecución de la estrategia al procesar el sobre fue OK (se logró procesar sin problemas).
setError()  : static
Asigna el error que ocurrió al procesar el sobre.
setMetadata()  : static
Asigna los metadatos del estado del resultado.

Properties

$error

El error que la estrategia generó al ser ejecutada.

private Throwable|null $error

Por ejemplo: una excepción lanzada.

$metadata

Metadatos del estado de resultado.

private BagInterface $metadata

$strategy

Código de la estrategia a la que está asociado este estado.

private string $strategy

Methods

__construct()

Constructor del estado de la estrategia.

public __construct(string $strategy[, Throwable|null $error = null ][, BagInterface|array<string|int, mixed> $metadata = [] ]) : mixed
Parameters
$strategy : string
$error : Throwable|null = null
$metadata : BagInterface|array<string|int, mixed> = []

addMetadata()

Agrega una clave específica a los metadatos.

public addMetadata(string $key, mixed $value) : static
Parameters
$key : string
$value : mixed
Return values
static

getError()

Entrega el error o excepción que se generó al procesar el sobre.

public getError() : Throwable|null
Return values
Throwable|null

getMetadata()

Obtiene los metadatos del estado del resultado.

public getMetadata() : BagInterface
Return values
BagInterface

getStrategy()

Entrega el código de la estrategia que generó este estado de intercambio de un sobre.

public getStrategy() : string
Return values
string

hasError()

Indica si el estado tiene un error.

public hasError() : bool
Return values
bool

isOk()

Indica si el estado del resultado de la ejecución de la estrategia al procesar el sobre fue OK (se logró procesar sin problemas).

public isOk() : bool
Return values
bool

setError()

Asigna el error que ocurrió al procesar el sobre.

public setError(Throwable $error) : static
Parameters
$error : Throwable
Return values
static

setMetadata()

Asigna los metadatos del estado del resultado.

public setMetadata(BagInterface|array<string|int, mixed> $metadata) : static
Parameters
$metadata : BagInterface|array<string|int, mixed>
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results