com.openindex.openestate.tool.agency

Class AgencyPlugin

java.lang.Object

org.java.plugin.Plugin

com.openindex.openestate.tool.ImmoToolPlugin

com.openindex.openestate.tool.ImmoToolProjectPlugin

com.openindex.openestate.tool.agency.AgencyPlugin

public final class AgencyPlugin
extends ImmoToolProjectPlugin

Hauptklasse des Add-Ons, basierend auf ImmoToolPlugin.

Author:

Andreas Rudolph

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgencyPlugin.ContactFormAction Show tab for a contact person.
static class	AgencyPlugin.ContactTableAction Show table with contact person.
static class	AgencyPlugin.EstateFormAction Show tab for a property.
static class	AgencyPlugin.EstateImportAction Import properties from a file.
static class	AgencyPlugin.EstateSaveAction Save properties to local harddisk.
static class	AgencyPlugin.EstateTableAction Show table with properties.
static class	AgencyPlugin.EstateUpdateAttachmentsAction Update attachments of properties.
static class	AgencyPlugin.ExportAction Launch property export process.
static class	AgencyPlugin.ExportCancelAction Cancel currently running property exports.
static class	AgencyPlugin.ExportEnableAction Enable / disable an export inteface.
static class	AgencyPlugin.ExportFormAction Show tab for a property export.
static class	AgencyPlugin.ExportJobCancelAction Cancel a currently running export process.
static class	AgencyPlugin.ExportJobErrorAction Show exception of a failed export process.
static class	AgencyPlugin.ExportJobRestartAction Restart a failed export process.
static class	AgencyPlugin.ExportLoadAction Import an export interface into the application.
static class	AgencyPlugin.ExportObjectsAction Show dialog for management of exportable properties.
static class	AgencyPlugin.ExportRemoveAction Remove an export interface.
static class	AgencyPlugin.ExportSaveAction Save an export interface to harddisk.
static class	AgencyPlugin.ExportTableAction Show table with export interfaces.
static class	AgencyPlugin.ExportUnlockAction Unlock an export interface.
static class	AgencyPlugin.ExportViewLogAction Show protocols for an export interface.
static class	AgencyPlugin.SearchDialogAction Show dialog for a property search.
static class	AgencyPlugin.SearchRemoveAction Remove a property search.
static class	AgencyPlugin.SidebarRefreshAction Refresh property view in sidebar.
static class	AgencyPlugin.SidebarSelectAction Show property view in sidebar.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_LAST_IMPORT_LOCATION
static String	ID
static String	IMAGE_FORMAT
static int	IMAGE_PREVIEW_HEIGHT
static int	IMAGE_PREVIEW_WIDTH
static String	RESOURCE_PATH
static String	USER_FAVOURED_SEARCH_IDS

Fields inherited from class org.java.plugin.Plugin

log

Constructor Summary

Constructors

Constructor and Description
AgencyPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop()
static DbAgencyExtension	getDbAgencyExtension()
String	getDescription()
ImageIcon	getIcon()
String	getId()
static int	getImageMaxHeight()
static int	getImageMaxWidth()
static AgencyPlugin	getInstance()
static File	getLastExportLocation()
static File	getLastImageLocation()
static File	getLastImportLocation()
String	getLicense()
static Locale[]	getLocales()
static Locale[]	getLocalesWithLanguagePack()
ProjectPermission[]	getPermissions()
String	getPhpExportVersion()
String[]	getRequiredProcedures()
String[]	getRequiredViews()
static Icon	getResourceIcon(String name, int size)
static Image	getResourceImage(String name, int size)
static URL	getResourceImageURL(String name, int size)
String	getTitle()
String	getUninstallQuery(String driverName)
DbUpdateHandler	getUpdateHandler(String driverName)
void	install(Connection c, DbExtension dbExtension, String driverName, boolean importDefaultData)
boolean	isAllowed(ImmoToolProject project)
static boolean	isApproximatedAttributes()
boolean	isUsable(ImmoToolProject project)
static boolean	isUserAllowedTo(AgencyPermission permission)
static boolean	isUserAllowedTo(AgencyPermission permission, ImmoToolProject project)
static void	loadSettings(ImmoToolProject project)
static void	loadSettings(ImmoToolProject project, Connection c)
void	repair(Connection c, AbstractDbDriver driver)
static void	saveSettings(Connection c, DbUser user, DbExtension dbExtension)
static void	saveSettings(Connection c, DbUser user, DbExtension dbExtension, DbAgencyExtension dbAgencyExtension)
static void	saveSettings(ImmoToolProject project)
static void	setApproximatedAttributes(boolean approximatedAttributes)
static void	setDbAgencyExtension(DbAgencyExtension dbAgencyExtension)
static void	setImageMaxHeight(int imageMaxHeight)
static void	setImageMaxWidth(int imageMaxWidth)
static void	setLastExportLocation(File lastExportLocation)
static void	setLastImageLocation(File lastImageLocation)
static void	setLastImportLocation(File file)
static void	setLocales(Locale[] locales)
static void	unloadSettings()

Methods inherited from class com.openindex.openestate.tool.ImmoToolProjectPlugin

getApiVersion, isAllowed, isUsable

Methods inherited from class com.openindex.openestate.tool.ImmoToolPlugin

getAuthor, getAuthorWebsite, getProperty, getProperty, getRequiredPlugins, getResourcePath, getVersion, getWebsite, isLicensed

Methods inherited from class org.java.plugin.Plugin

getDescriptor, getManager, isActive, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

RESOURCE_PATH

public static final String RESOURCE_PATH

See Also:

Constant Field Values

IMAGE_FORMAT

public static final String IMAGE_FORMAT

See Also:

Constant Field Values

IMAGE_PREVIEW_WIDTH

public static final int IMAGE_PREVIEW_WIDTH

See Also:

Constant Field Values

IMAGE_PREVIEW_HEIGHT

public static final int IMAGE_PREVIEW_HEIGHT

See Also:

Constant Field Values

APP_LAST_IMPORT_LOCATION

public static final String APP_LAST_IMPORT_LOCATION

See Also:

Constant Field Values

USER_FAVOURED_SEARCH_IDS

public static final String USER_FAVOURED_SEARCH_IDS

See Also:

Constant Field Values

Constructor Detail

AgencyPlugin

public AgencyPlugin()

Method Detail

doStart

protected void doStart()
                throws Exception

Specified by:

doStart in class org.java.plugin.Plugin

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Specified by:

doStop in class org.java.plugin.Plugin

Throws:

Exception

getDbAgencyExtension

public static DbAgencyExtension getDbAgencyExtension()

getDescription

public String getDescription()

Overrides:

getDescription in class ImmoToolPlugin

getIcon

public ImageIcon getIcon()

Overrides:

getIcon in class ImmoToolPlugin

getId

public String getId()

Specified by:

getId in class ImmoToolPlugin

getImageMaxHeight

public static int getImageMaxHeight()

getImageMaxWidth

public static int getImageMaxWidth()

getInstance

public static AgencyPlugin getInstance()

getLastExportLocation

public static File getLastExportLocation()

getLastImageLocation

public static File getLastImageLocation()

getLastImportLocation

public static File getLastImportLocation()

getLicense

public String getLicense()

Overrides:

getLicense in class ImmoToolPlugin

getLocales

public static Locale[] getLocales()

getLocalesWithLanguagePack

public static Locale[] getLocalesWithLanguagePack()

getPermissions

public ProjectPermission[] getPermissions()

Specified by:

getPermissions in class ImmoToolProjectPlugin

getPhpExportVersion

public String getPhpExportVersion()

getRequiredProcedures

public String[] getRequiredProcedures()

Specified by:

getRequiredProcedures in class ImmoToolProjectPlugin

getRequiredViews

public String[] getRequiredViews()

Specified by:

getRequiredViews in class ImmoToolProjectPlugin

getResourceIcon

public static Icon getResourceIcon(String name,
                   int size)

getResourceImage

public static Image getResourceImage(String name,
                     int size)

getResourceImageURL

public static URL getResourceImageURL(String name,
                      int size)

getTitle

public String getTitle()

Overrides:

getTitle in class ImmoToolPlugin

getUninstallQuery

public String getUninstallQuery(String driverName)
                         throws IOException

Specified by:

getUninstallQuery in class ImmoToolProjectPlugin

Throws:

IOException

getUpdateHandler

public DbUpdateHandler getUpdateHandler(String driverName)

Specified by:

getUpdateHandler in class ImmoToolProjectPlugin

install

public void install(Connection c,
           DbExtension dbExtension,
           String driverName,
           boolean importDefaultData)
             throws SQLException,
                    IOException

Overrides:

install in class ImmoToolProjectPlugin

Throws:

SQLException

IOException

isAllowed

public boolean isAllowed(ImmoToolProject project)

Overrides:

isAllowed in class ImmoToolProjectPlugin

isApproximatedAttributes

public static boolean isApproximatedAttributes()

isUsable

public boolean isUsable(ImmoToolProject project)

Overrides:

isUsable in class ImmoToolProjectPlugin

isUserAllowedTo

public static boolean isUserAllowedTo(AgencyPermission permission)

isUserAllowedTo

public static boolean isUserAllowedTo(AgencyPermission permission,
                      ImmoToolProject project)

loadSettings

public static void loadSettings(ImmoToolProject project)
                         throws SQLException,
                                IOException

Throws:

SQLException

IOException

loadSettings

public static void loadSettings(ImmoToolProject project,
                Connection c)
                         throws SQLException,
                                IOException

Throws:

SQLException

IOException

repair

public void repair(Connection c,
          AbstractDbDriver driver)
            throws SQLException

Overrides:

repair in class ImmoToolProjectPlugin

Throws:

SQLException

saveSettings

public static void saveSettings(ImmoToolProject project)
                         throws SQLException,
                                IOException

Throws:

SQLException

IOException

saveSettings

public static void saveSettings(Connection c,
                DbUser user,
                DbExtension dbExtension)
                         throws SQLException,
                                IOException

Throws:

SQLException

IOException

saveSettings

public static void saveSettings(Connection c,
                DbUser user,
                DbExtension dbExtension,
                DbAgencyExtension dbAgencyExtension)
                         throws SQLException,
                                IOException

Throws:

SQLException

IOException

setApproximatedAttributes

public static void setApproximatedAttributes(boolean approximatedAttributes)

setDbAgencyExtension

public static void setDbAgencyExtension(DbAgencyExtension dbAgencyExtension)

setImageMaxHeight

public static void setImageMaxHeight(int imageMaxHeight)

setImageMaxWidth

public static void setImageMaxWidth(int imageMaxWidth)

setLastExportLocation

public static void setLastExportLocation(File lastExportLocation)

setLastImageLocation

public static void setLastImageLocation(File lastImageLocation)

setLastImportLocation

public static void setLastImportLocation(File file)

setLocales

public static void setLocales(Locale[] locales)

unloadSettings

public static void unloadSettings()