daikon-cqrs/event-sourcing

<?php declare(strict_types=1);
/**
 * This file is part of the daikon-cqrs/event-sourcing project.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Daikon\EventSourcing\Aggregate\Event;

use Countable;
use Daikon\EventSourcing\Aggregate\AggregateRevision;
use Daikon\Interop\FromNativeInterface;
use Daikon\Interop\MakeEmptyInterface;
use Daikon\Interop\ToNativeInterface;
use IteratorAggregate;

interface DomainEventSequenceInterface extends
    IteratorAggregate,
    Countable,
    MakeEmptyInterface,
    FromNativeInterface,
    ToNativeInterface
{
    public function push(DomainEventInterface $event): self;

    public function append(DomainEventSequenceInterface $events): self;

    public function resequence(AggregateRevision $aggregateRevision): self;

    public function getHeadRevision(): AggregateRevision;

    public function getTailRevision(): AggregateRevision;

    public function getTail(): DomainEventInterface;

    public function getHead(): DomainEventInterface;

    /** @return int|bool */
    public function indexOf(DomainEventInterface $event);
}