<?php
/**
 * @copyright Copyright (c) 2017 Julius Härtl <jus@bitgrid.net>
 *
 * @author Julius Härtl <jus@bitgrid.net>
 *
 * @license GNU AGPL version 3 or any later version
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  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 Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace OCA\IssueTemplate;

interface IDetail {

	const TYPE_SINGLE_LINE = 0;
	const TYPE_MULTI_LINE = 1;
	const TYPE_MULTI_LINE_PREFORMAT = 2;
	const TYPE_COLLAPSIBLE = 3;
	const TYPE_COLLAPSIBLE_PREFORMAT = 4;
	const TYPE_BOOLEAN = 5;

	/**
	 * Returns a unique identifier for the detail value
	 *
	 * @return string
	 */
	public function getIdentifier();

	/**
	 * Returns the human readable title of the detail value
	 *
	 * @return string
	 */
	public function getTitle();

	/**
	 * Returns the type of the detail field
	 *
	 * @return int
	 */
	public function getType();

	/**
	 * Returns the value that should be presented in the issue report
	 *
	 * @return string
	 */
	public function getInformation();

	/**
	 * Return the parent section that the detail is linked to
	 *
	 * @return ISection
	 */
	public function getSection();
}