ExchangeComponentInterface
extends
ComponentInterface
in
Interfaz para `ExchangeComponent`.
Table of Contents
Methods
- getReceiverWorker() : ReceiverWorkerInterface
- Entrega el worker "billing.exchange.receiver".
- getSenderWorker() : SenderWorkerInterface
- Entrega el worker "billing.exchange.sender".
- handle() : array<string|int, ExchangeResultInterface>
- Procesa una bolsa de intercambio, sus sobres y documentos.
- receive() : array<string|int, ExchangeResultInterface>
- Recibe documentos a través del proceso de intercambio mediante la estrategia definida en la bolsa.
- send() : array<string|int, ExchangeResultInterface>
- Envía documentos a través del proceso de intercambio mediante la estrategia definida en la bolsa.
Methods
getReceiverWorker()
Entrega el worker "billing.exchange.receiver".
public
getReceiverWorker() : ReceiverWorkerInterface
Return values
ReceiverWorkerInterfacegetSenderWorker()
Entrega el worker "billing.exchange.sender".
public
getSenderWorker() : SenderWorkerInterface
Return values
SenderWorkerInterfacehandle()
Procesa una bolsa de intercambio, sus sobres y documentos.
public
handle(ExchangeBagInterface $bag) : array<string|int, ExchangeResultInterface>
Este método determinará "qué" sobres de la bolsa debe transportar, y si es posible transportarlos los pasará a las estrategias que correspondan para que realicen el intercambio.
Si bien existe receive() y send(), este método es necesario porque se podría querer realizar el transporte utilizando múltiples estrategias disponibles y soportadas por el worker.
La decisión de si es un envío o recepción se toma simplemente según si la bolsa tiene o no asignados sobres al ser procesada. Si tiene sobres es un envío, si no tiene es recepción. Se espera que las opciones de la bolsa coincidan con la acción que se realizará.
Parameters
- $bag : ExchangeBagInterface
-
Bolsa con los sobres y opciones para realizar el intercambio de documentos.
Return values
array<string|int, ExchangeResultInterface> —Los resultados de procesar los sobres de la bolsa. Tiene el estado de cada estrategia que procesó el sobre.
receive()
Recibe documentos a través del proceso de intercambio mediante la estrategia definida en la bolsa.
public
receive(ExchangeBagInterface $bag) : array<string|int, ExchangeResultInterface>
Parameters
- $bag : ExchangeBagInterface
-
Bolsa con las opciones para realizar el intercambio de documentos.
Return values
array<string|int, ExchangeResultInterface> —El resultado del intercambio donde cada resultado contiene un sobre con el estado de la recepción.
send()
Envía documentos a través del proceso de intercambio mediante la estrategia definida en la bolsa.
public
send(ExchangeBagInterface $bag) : array<string|int, ExchangeResultInterface>
Parameters
- $bag : ExchangeBagInterface
-
Bolsa con los sobres y opciones para realizar el intercambio de documentos.
Return values
array<string|int, ExchangeResultInterface> —Los resultados de procesar los sobres de la bolsa. Tiene el estado de cada estrategia que procesó el sobre.