<?php
/**
 * @copyright Copyright (c) 2020 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 OCP\Dashboard;

/**
 * Interface IPanel
 *
 * @package OCP\Dashboard
 * @since 20.0.0
 */
interface IPanel {

	/**
	 * @return string
	 * @since 20.0.0
	 */
	public function getId(): string;

	/**
	 * @return string
	 * @since 20.0.0
	 */
	public function getTitle(): string;

	/**
	 * @return int
	 * @since 20.0.0
	 */
	public function getOrder(): int;

	/**
	 * @return string
	 * @since 20.0.0
	 */
	public function getIconClass(): string;

	/**
	 * @return string The absolute url to the apps own view
	 * @since 20.0.0
	 */
	public function getUrl(): string;
}