<?php

/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2015 (original work) Open Assessment Technologies SA;
 *
 *
 */

namespace oat\taoRevision\model;

/**
 * A revision of a resource
 *
 * @author Joel Bout <joel@taotesting.com>
 */
final class Revision
{
    /** @var string Resource Identifier */
    private $resourceId;

    /** @var int Version number of the resource */
    private $version;

    /** @var int Creation date of the revision in UNIX timestamp */
    private $created;

    /** @var string User who created the revision */
    private $author;

    /** @var string Commit message */
    private $message;

    public function __construct(string $resourceId, int $version, int $created, string $author, string $message)
    {
        $this->resourceId = $resourceId;
        $this->version = $version;
        $this->created = $created;
        $this->author = $author;
        $this->message = $message;
    }

    /**
     * Returns the revisioned resource identifier
     * @return string
     */
    public function getResourceId()
    {
        return $this->resourceId;
    }

    /**
     * Returns the version of the revision
     * @return int
     */
    public function getVersion()
    {
        return $this->version;
    }

    /**
     * Returns the message associated with the revision
     * @return string
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Returns the creation date as epoch timestamp
     * @return int
     */
    public function getDateCreated()
    {
        return $this->created;
    }

    /**
     * Returns the identifier of the user that created
     * the revision
     * @return string
     */
    public function getAuthorId()
    {
        return $this->author;
    }
}