ExchangeResultInterface
extends
JsonSerializable
in
Interfaz para el resultado del proceso de intercambio de un sobre.
Table of Contents
Methods
- addMetadata() : static
- Agrega una clave específica a los metadatos.
- addStatus() : static
- Agrega el estado de resultado de una estrategia al resultado general del intercambio del sobre.
- getEnvelope() : EnvelopeInterface
- Obtiene el sobre asociado a la operación, y resultado, de intercambio.
- getMetadata() : BagInterface
- Obtiene los metadatos del resultado.
- getStatuses() : array<string|int, ExchangeStatusInterface>
- Entrega los estados del intercambio de las estrategias que participaron en el intercambio del sobre asociado.
- getStrategies() : array<string|int, string>
- Entrega los códigos de las estrategias que procesaron el sobre.
- setMetadata() : static
- Asigna los metadatos del resultado.
- toArray() : array<string|int, mixed>
- Convierte el resultado a un array.
Methods
addMetadata()
Agrega una clave específica a los metadatos.
public
addMetadata(string $key, mixed $value) : static
Parameters
- $key : string
- $value : mixed
Return values
staticaddStatus()
Agrega el estado de resultado de una estrategia al resultado general del intercambio del sobre.
public
addStatus(ExchangeStatusInterface $status) : static
Parameters
- $status : ExchangeStatusInterface
Return values
staticgetEnvelope()
Obtiene el sobre asociado a la operación, y resultado, de intercambio.
public
getEnvelope() : EnvelopeInterface
Return values
EnvelopeInterfacegetMetadata()
Obtiene los metadatos del resultado.
public
getMetadata() : BagInterface
Return values
BagInterfacegetStatuses()
Entrega los estados del intercambio de las estrategias que participaron en el intercambio del sobre asociado.
public
getStatuses() : array<string|int, ExchangeStatusInterface>
Return values
array<string|int, ExchangeStatusInterface>getStrategies()
Entrega los códigos de las estrategias que procesaron el sobre.
public
getStrategies() : array<string|int, string>
Return values
array<string|int, string>setMetadata()
Asigna los metadatos del resultado.
public
setMetadata(BagInterface|array<string|int, mixed> $metadata) : static
Parameters
- $metadata : BagInterface|array<string|int, mixed>
Return values
statictoArray()
Convierte el resultado a un array.
public
toArray() : array<string|int, mixed>
El sobre se referencia por su businessMessageID (no se embebe
completo) — el sobre completo siempre está disponible en
ExchangeBagInterface::toArray()['envelopes'], ya que
ExchangeBag::addResult() garantiza que todo sobre con un resultado
también quede agregado a los sobres de la bolsa.