project35.soa.plugins
Interface Project35Plugin

All Superinterfaces:

java.io.Serializable, ServiceClass

All Known Subinterfaces:

TabletProject35Plugin

All Known Implementing Classes:

AbstractProject35Plugin, CloseMetaDataFile, ContextHelpPageCreationPlugin, DefaultConfigurationFileCreationPlugin, DefaultOntologyServiceDescriptionsPlugin, ExitMetaDataEditor, GenerateFunctionalSpecificationsPlugin, OntologyIdentifierCreationPlugin, OpenMetaDataFile, PostAnnotationPlugin, SaveMetaDataFile, StubbedProject35Plugin, TestApplicationPlugin

public interface Project35Plugin
extends ServiceClass

the interface developers must implement if they want to make plugins for Project35

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Method Summary

void	execute(Project35FormContext project35FormContext) execute the plugin
java.net.URL	getHelpLink() web page that shows help about the plugin
boolean	isSuitableForRecordModel(java.lang.String modelStamp, java.lang.String recordClassName)

Methods inherited from interface project35.soa.ServiceClass

getInitialisationParameters, initialiseService

Method Detail

isSuitableForRecordModel

boolean isSuitableForRecordModel(java.lang.String modelStamp,
                                 java.lang.String recordClassName)

Parameters:

modelStamp - - is the model stamp currently being used by the application.

recordClassName - - the record class of a target record model, usually the currently displayed one.

execute

void execute(Project35FormContext project35FormContext)
             throws java.lang.Exception

execute the plugin

Throws:

java.lang.Exception

getHelpLink

java.net.URL getHelpLink()

web page that shows help about the plugin