ExchangeStatusInterface
in
Interfaz para el estado del resultado de una estrategia de intercambio de un sobre específico.
Table of Contents
Methods
- 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.
Methods
addMetadata()
Agrega una clave específica a los metadatos.
public
addMetadata(string $key, mixed $value) : static
Parameters
- $key : string
- $value : mixed
Return values
staticgetError()
Entrega el error o excepción que se generó al procesar el sobre.
public
getError() : Throwable|null
Return values
Throwable|nullgetMetadata()
Obtiene los metadatos del estado del resultado.
public
getMetadata() : BagInterface
Return values
BagInterfacegetStrategy()
Entrega el código de la estrategia que generó este estado de intercambio de un sobre.
public
getStrategy() : string
Return values
stringhasError()
Indica si el estado tiene un error.
public
hasError() : bool
Return values
boolisOk()
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
boolsetError()
Asigna el error que ocurrió al procesar el sobre.
public
setError(Throwable $error) : static
Parameters
- $error : Throwable
Return values
staticsetMetadata()
Asigna los metadatos del estado del resultado.
public
setMetadata(BagInterface|array<string|int, mixed> $metadata) : static
Parameters
- $metadata : BagInterface|array<string|int, mixed>