<?php
/*
* This file is part of Chevere.
*
* (c) Rodolfo Berrios <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Chevere\Workflow\Interfaces;
use Chevere\DataStructure\Interfaces\StringMappedInterface;
use Chevere\DataStructure\Interfaces\VectorInterface;
use Chevere\Parameter\Interfaces\ArgumentsInterface;
use Chevere\Parameter\Interfaces\CastInterface;
/**
* Describes the component in charge of defining a workflow run, with arguments returned for each job.
*
* @extends StringMappedInterface<CastInterface>
*/
interface RunInterface extends StringMappedInterface
{
/**
* @return array<string> Names for jobs with responses.
*/
public function keys(): array;
/**
* Provides access to workflow uuid V4 (RFC 4122).
* https://tools.ietf.org/html/rfc4122
*/
public function uuid(): string;
/**
* Provides access to the workflow instance.
*/
public function workflow(): WorkflowInterface;
/**
* Provides access to the arguments instance.
*/
public function arguments(): ArgumentsInterface;
/**
* @return VectorInterface<string>
*/
public function skip(): VectorInterface;
public function withResponse(string $job, CastInterface $response): self;
public function withSkip(string ...$job): self;
/**
* Provides access to the CastInterface instance for the given `$job`.
*/
public function response(string $job, string|int ...$key): CastInterface;
/**
* @deprecated Use `response` instead.
*/
public function getReturn(string $job): CastInterface;
}
|
Download
