org.bimserver.plugins.Plugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of PluginBase Show documentation

Base project for BIMserver plugin development. Some plugins mights also need the Shared library

There is a newer version: 2.0.0

package org.bimserver.plugins;

/******************************************************************************
 * Copyright (C) 2009-2016  BIMserver.org
 * 
 * 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 {@literal}.
 *****************************************************************************/

import org.bimserver.models.store.ObjectDefinition;
import org.bimserver.shared.exceptions.PluginException;

public interface Plugin {
	/**
	 * Initialize this plugin
	 * @param pluginManager
	 * @throws PluginException
	 */
	void init(PluginManagerInterface pluginManager) throws PluginException;
	
	/**
	 * @return A description of this plugin
	 */
	String getDescription();
	
	/**
	 * @return The default name of this plugin, a user can later change the name
	 */
	String getDefaultName();
	
	/**
	 * @return The version of this plugin, for now it's not used for dependencies, only for (manual) identification
	 */
	String getVersion();
	/**
	 * @return An object with the definition of a set of properties that can be set by the user of a plugin, the plugin can later use the actual values a user has set
	 */
	ObjectDefinition getSettingsDefinition();
	/**
	 * @return Whether the plugin has successfully initialized
	 */
	boolean isInitialized();
}