ClearingDecisionBuilder.php

<?php
/*
Copyright (C) 2014-2018, Siemens AG
Author: Johannes Najjar

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
version 2 as published by the Free Software Foundation.

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.
*/

namespace Fossology\Lib\Data;

use Fossology\Lib\Data\Clearing\ClearingEvent;
use Fossology\Lib\Exception;

class ClearingDecisionBuilder
{
  private $sameFolder;
  private $clearingEvents;
  private $clearingId;
  private $uploadTreeId;
  private $pfileId;
  private $userName;
  private $userId;
  private $type;
  private $comment;
  private $reportinfo;
  private $acknowledgement;
  private $scope;
  private $timeStamp;

  function __construct()
  {
    $this->sameFolder = false;
    $this->clearingEvents = array();
    $this->clearingId = -1;
    $this->uploadTreeId = -1;
    $this->pfileId = -1;
    $this->userName = "fossy";
    $this->userId = -1;
    $this->type = null;
    $this->scope = DecisionScopes::ITEM;
    $this->timeStamp = time();
  }

  public function setClearingId($clearingId)
  {
    $this->clearingId = intval($clearingId);
    return $this;
  }

  public function setTimeStamp($timestamp)
  {
    $this->timeStamp = $timestamp;
    return $this;
  }

  public function setClearingEvents($events)
  {
    $this->clearingEvents = $events;
    return $this;
  }

  public function setPfileId($pfileId)
  {
    $this->pfileId = intval($pfileId);
    return $this;
  }

  public function setSameFolder($sameFolder)
  {
    $this->sameFolder = $sameFolder;
    return $this;
  }

  public function setType($type)
  {
    $this->type = $type;
    return $this;
  }

  public function setScope($scope)
  {
    $this->scope = $scope;
    return $this;
  }

  public function setUploadTreeId($uploadTreeId)
  {
    $this->uploadTreeId = $uploadTreeId;
    return $this;
  }

  public function setUserId($userId)
  {
    $this->userId = $userId;
    return $this;
  }

  public function setUserName($userName)
  {
    $this->userName = $userName;
    return $this;
  }

  public static function create()
  {
    return new ClearingDecisionBuilder();
  }

  public function copy(ClearingDecision $clearingDecision)
  {
    $this->sameFolder = $clearingDecision->getSameFolder();
    $this->clearingEvents = $clearingDecision->getClearingEvents();
    $this->clearingId = $clearingDecision->getClearingId();
    $this->uploadTreeId = $clearingDecision->getUploadTreeId();
    $this->pfileId = $clearingDecision->getPfileId();
    $this->userName = $clearingDecision->getUserName();
    $this->userId = $clearingDecision->getUserId();
    $this->type = $clearingDecision->getType();
    $this->comment = $clearingDecision->getComment();
    $this->reportinfo = $clearingDecision->getReportinfo();
    $this->acknowledgement = $clearingDecision->getAcknowledgement();
    $this->scope = $clearingDecision->getScope();
    $this->timeStamp = $clearingDecision->getTimeStamp();
  }

  public function build()
  {
    if ($this->type === null) {
      throw new Exception("decision type should be set");
    }

    return new ClearingDecision($this->sameFolder, $this->clearingId,
        $this->uploadTreeId, $this->pfileId, $this->userName, $this->userId, $this->type, $this->scope,
        $this->timeStamp, $this->clearingEvents, $this->reportinfo, $this->comment, $this->acknowledgement);
  }
}