ClearingResult.php

<?php
/*
Copyright (C) 2014-2018, Siemens AG

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\Clearing;

use Fossology\Lib\Data\LicenseRef;
use Fossology\Lib\Exception;

class ClearingResult implements LicenseClearing
{

  const AGENT_DECISION_TYPE = 'agent';

  private $clearingEvent;
  private $agentClearingEvents;

  public function __construct($licenseDecisionEvent,
    $agentDecisionEvents = array())
  {
    if (($licenseDecisionEvent === null) && (count($agentDecisionEvents) == 0)) {
      throw new Exception(
        "cannot create ClearingEvent without any event contained");
    }

    $this->clearingEvent = $licenseDecisionEvent;
    $this->agentClearingEvents = $agentDecisionEvents;
  }

  public function getLicenseRef()
  {
    return $this->getClearing()->getLicenseRef();
  }

  function getLicenseId()
  {
    return $this->getClearing()->getLicenseId();
  }

  function getLicenseFullName()
  {
    return $this->getClearing()->getLicenseFullName();
  }

  function getLicenseShortName()
  {
    return $this->getClearing()->getLicenseShortName();
  }

  public function getComment()
  {
    return isset($this->clearingEvent) ? $this->clearingEvent->getComment() : '';
  }

  public function getEventType()
  {
    return $this->getClearing()->getEventType();
  }

  public function getReportinfo()
  {
    return isset($this->clearingEvent) ? $this->clearingEvent->getReportinfo() : '';
  }

  public function getAcknowledgement()
  {
    return isset($this->clearingEvent) ? $this->clearingEvent->getAcknowledgement() : '';
  }

  public function isRemoved()
  {
    return $this->getClearing()->isRemoved();
  }

  private function getClearing()
  {
    if (isset($this->clearingEvent)) {
      return $this->clearingEvent;
    }

    return $this->agentClearingEvents[0];
  }

  public function hasAgentDecisionEvent()
  {
    return !empty($this->agentClearingEvents);
  }

  public function hasClearingEvent()
  {
    return isset($this->clearingEvent);
  }

  public function getAgentDecisionEvents()
  {
    return $this->agentClearingEvents;
  }

  public function getClearingEvent()
  {
    return $this->clearingEvent;
  }

  /*
   * @return int clearing timestamp
   */
  public function getTimeStamp()
  {
    return $this->getClearing()->getTimeStamp();
  }
}