project35.configurationTool
Class GenerateFunctionalSpecificationsPlugin

java.lang.Object
  project35.soa.plugins.AbstractProject35Plugin
      project35.configurationTool.GenerateFunctionalSpecificationsPlugin

All Implemented Interfaces:

java.io.Serializable, Project35Plugin, ServiceClass

public class GenerateFunctionalSpecificationsPlugin
extends AbstractProject35Plugin

This plugin is for use with the project35_configuration_tool model It finds the root of a document that describes the configuration options for a given target schema. It prompts the users to make some choices about what kind of context help pages they ant.

Copyright (c) 2008 Kevin Garwood for Project35. This code is 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),

See Also:

Serialized Form

Field Summary

Fields inherited from class project35.soa.plugins.AbstractProject35Plugin

initialisationParameters, resourceDirectory

Constructor Summary

GenerateFunctionalSpecificationsPlugin()

Method Summary

void	execute(Project35FormContext configurationToolFormContext) 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) public String getDisplayName() { String displayName = Project35Resources.getMessage("project35.plugins.generateFunctionalSpecifications.title"); return displayName; } public String getDescription() { String description = Project35Resources.getMessage("project35.plugins.generateFunctionalSpecifications.description"); return description; }

Methods inherited from class project35.soa.plugins.AbstractProject35Plugin

getDescription, getDisplayName, getInitialisationParameters, initialiseService, setDescription, setDisplayName

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateFunctionalSpecificationsPlugin

public GenerateFunctionalSpecificationsPlugin()

Method Detail

isSuitableForRecordModel

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

public String getDisplayName() { String displayName = Project35Resources.getMessage("project35.plugins.generateFunctionalSpecifications.title"); return displayName; } public String getDescription() { String description = Project35Resources.getMessage("project35.plugins.generateFunctionalSpecifications.description"); return description; }

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

public void execute(Project35FormContext configurationToolFormContext)

Description copied from interface: Project35Plugin

execute the plugin

getHelpLink

public java.net.URL getHelpLink()

Description copied from interface: Project35Plugin

web page that shows help about the plugin

Specified by:

getHelpLink in interface Project35Plugin

Overrides:

getHelpLink in class AbstractProject35Plugin