com.novell.emframe.dev
Class CustomTargetChooser

java.lang.Object
  com.novell.emframe.dev.CustomTargetChooser

public abstract class CustomTargetChooser

extends java.lang.Object

Abstract class to implement to become a custom target chooser for a plug-in created with the Plug-in Studio. The target chooser page is the first page displayed by a plug-in that asks the user to identify which object or objects to perform the task on. If you implement a custom target chooser, you will have to have a .jsp page that displays the UI for your target chooser and put any information the .jsp needs on the HttpServletRequest object from context.getRequest().

In addition, once the user selects an object or objects to perform the task on with your custom target chooser, you will have to put various parameters on the request so the Plug-in Studio created task will be able to move to the next step.

For an example, see the webapps/nps/portal/modules/fw/skins/default/devices/default/ListTargetChooser.jsp.

Constructor Summary

CustomTargetChooser()

Method Summary

abstract java.lang.String

showTargetChooser(TaskContext context, org.jdom.Document doc) Abstract method you have to implement.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomTargetChooser

public CustomTargetChooser()

Method Detail

showTargetChooser

public abstract java.lang.String showTargetChooser(TaskContext context,
                                                   org.jdom.Document doc)
                                            throws PluginException

Abstract method you have to implement. This method is called giving you the task context and your Document object containing the DOM of your element used to register your class as a target chooser. To register your custom target chooser, you will have to edit the .xml file created by the Plug-in Studio that registers the custom task with iManager and add the following elements:
<task>
...(other task related elements)...
<rbs-xml-info>
<custom-target-chooser>
<class-name>(class that implements the CustomTargetChooser class)</class-name>
</custom-target-chooser>
</rbs-xml-info>
</task>

Parameters:

context - TaskContext for your target chooser to use

doc - org.jdom.Document object containing the xml used to register the task with iManager

Returns:

String containing the .jsp file to use in the form "module.jspfile" such as "fw.ListTargetChooser" without the .jsp on the end of the String

Throws:

PluginException - if your target chooser experiences an error