com.openindex.openestate.tool.utils.engine
Interface Pluggable

All Known Implementing Classes:
AgencyPlugin, CalendarPlugin, ContactsPlugin, ImmoToolLanguagePack, ImmoToolLanguagePack_de, ImmoToolPlugin, Plugin

public interface Pluggable

define a plugin for a program.
$Id: Pluggable.java 856 2011-04-29 22:30:40Z andy $

Author:
Christophe Le Besnerais, Andreas Rudolph

Method Summary
 void destroy()
          this method will be called when this plugin is deleted, so you can free ressources, or restore some settings etc ...
 String getDescription()
           
 BufferedImage getIcon()
           
 int getMinimalVersion()
           
 String getName()
           
 URI getURI()
           
 String getVersion()
           
 boolean hasOptions()
           
 void init(Object... args)
          this method will be called when the main program start if this plugin is installed
 void openOptions()
          if hasOptions() return true, this method will be called when the user want to edit the options from this plugin.
 

Method Detail

getName

String getName()
Returns:
the name for this plugin, should not be null

getVersion

String getVersion()
Returns:
the version for this plugin

getMinimalVersion

int getMinimalVersion()
Returns:
the minimal version of the main application for which this plugin can work

getDescription

String getDescription()
Returns:
the description for this plugin

getIcon

BufferedImage getIcon()
Returns:
the icon for this plugin

getURI

URI getURI()
Returns:
the place where the XML descriptor for this plugin can be found, should not be null

init

void init(Object... args)
this method will be called when the main program start if this plugin is installed

Parameters:
args - arguments given by the main program

destroy

void destroy()
this method will be called when this plugin is deleted, so you can free ressources, or restore some settings etc ... (the files insides the plugin directory are automatically deleted, so you don't have to take care of this)


hasOptions

boolean hasOptions()
Returns:
true if has some options to configure by the user

openOptions

void openOptions()
if hasOptions() return true, this method will be called when the user want to edit the options from this plugin.



Copyright © 2012 OpenEstate. All Rights Reserved.