<?php

/**
 * @file classes/log/SubmissionEmailLogEntry.inc.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2003-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class SubmissionEmailLogEntry
 * @ingroup log
 * @see SubmissionEmailLogDAO
 *
 * @brief Base class for describing an entry in the submission email log.
 */

import('lib.pkp.classes.log.EmailLogEntry');

// General events						0x10000000

// Author events						0x20000000
define('SUBMISSION_EMAIL_AUTHOR_NOTIFY_REVISED_VERSION',			0x20000001);

// Editor events						0x30000000
define('SUBMISSION_EMAIL_EDITOR_NOTIFY_AUTHOR',			0x30000001);
define('SUBMISSION_EMAIL_EDITOR_ASSIGN',				0x30000002);
define('SUBMISSION_EMAIL_EDITOR_NOTIFY_AUTHOR_UNSUITABLE',	0x30000003);
define('SUBMISSION_EMAIL_EDITOR_RECOMMEND_NOTIFY',	0x30000004);

// Reviewer events						0x40000000
define('SUBMISSION_EMAIL_REVIEW_NOTIFY_REVIEWER',		0x40000001);
define('SUBMISSION_EMAIL_REVIEW_THANK_REVIEWER',			0x40000002);
define('SUBMISSION_EMAIL_REVIEW_CANCEL',				0x40000003);
define('SUBMISSION_EMAIL_REVIEW_REMIND',				0x40000004);
define('SUBMISSION_EMAIL_REVIEW_CONFIRM',			0x40000005);
define('SUBMISSION_EMAIL_REVIEW_DECLINE',			0x40000006);
define('SUBMISSION_EMAIL_REVIEW_CONFIRM_ACK',			0x40000008);

// Copyeditor events						0x50000000
define('SUBMISSION_EMAIL_COPYEDIT_NOTIFY_COPYEDITOR',		0x50000001);
define('SUBMISSION_EMAIL_COPYEDIT_NOTIFY_AUTHOR',		0x50000002);
define('SUBMISSION_EMAIL_COPYEDIT_NOTIFY_FINAL',			0x50000003);
define('SUBMISSION_EMAIL_COPYEDIT_NOTIFY_COMPLETE',		0x50000004);
define('SUBMISSION_EMAIL_COPYEDIT_NOTIFY_AUTHOR_COMPLETE',	0x50000005);
define('SUBMISSION_EMAIL_COPYEDIT_NOTIFY_FINAL_COMPLETE',	0x50000006);
define('SUBMISSION_EMAIL_COPYEDIT_NOTIFY_ACKNOWLEDGE',		0x50000007);
define('SUBMISSION_EMAIL_COPYEDIT_NOTIFY_AUTHOR_ACKNOWLEDGE',	0x50000008);
define('SUBMISSION_EMAIL_COPYEDIT_NOTIFY_FINAL_ACKNOWLEDGE',	0x50000009);

// Proofreader events						0x60000000
define('SUBMISSION_EMAIL_PROOFREAD_NOTIFY_AUTHOR',		0x60000001);
define('SUBMISSION_EMAIL_PROOFREAD_NOTIFY_AUTHOR_COMPLETE',	0x60000002);
define('SUBMISSION_EMAIL_PROOFREAD_THANK_AUTHOR',		0x60000003);
define('SUBMISSION_EMAIL_PROOFREAD_NOTIFY_PROOFREADER',		0x60000004);
define('SUBMISSION_EMAIL_PROOFREAD_NOTIFY_PROOFREADER_COMPLETE',	0x60000005);
define('SUBMISSION_EMAIL_PROOFREAD_THANK_PROOFREADER',		0x60000006);
define('SUBMISSION_EMAIL_PROOFREAD_NOTIFY_LAYOUTEDITOR',		0x60000007);
define('SUBMISSION_EMAIL_PROOFREAD_NOTIFY_LAYOUTEDITOR_COMPLETE',0x60000008);
define('SUBMISSION_EMAIL_PROOFREAD_THANK_LAYOUTEDITOR',		0x60000009);

// Layout events						0x70000000
define('SUBMISSION_EMAIL_LAYOUT_NOTIFY_EDITOR',			0x70000001);
define('SUBMISSION_EMAIL_LAYOUT_THANK_EDITOR',			0x70000002);
define('SUBMISSION_EMAIL_LAYOUT_NOTIFY_COMPLETE',		0x70000003);

class SubmissionEmailLogEntry extends EmailLogEntry {
	/**
	 * Set the submission ID for the log entry.
	 * @param $submissionId int
	 */
	function setSubmissionId($submissionId) {
		return $this->setAssocId($submissionId);
	}

	/**
	 * Get the submission ID for the log entry.
	 * @return int
	 */
	function getSubmissionId() {
		return $this->getAssocId();
	}
}