Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.perspective.model.ui
Class AbstractISVWizardPage

java.lang.Object
  extended by WizardPage
      extended by com.ibm.etools.iseries.perspective.model.ui.AbstractISVWizardPage

public abstract class AbstractISVWizardPage
extends WizardPage

This is the abstract class that ISV providers should implement if they want to contribute an additional WizardPage to any of the iSeries Perspective wizard pages. Note: Implementations of this class are only to be used as valid values for the iSeries ISV property extension point, not as regular Wizard Pages.


Field Summary
static String Copyright
           
 
Constructor Summary
AbstractISVWizardPage()
          Constructor for ISVWizardPage.
 
Method Summary
 void cacheProperty(String key, String value)
          This is used to cache a property and its value for later generating in the metadata file generated by this wizard.
It is important to note here that both key and value are strings.
 void removeCachedProperty(String key)
          Removes this cached property from this wizard's cached property values.
 void resourceCreated(AbstractISeriesResource iSeriesResource)
          This method will be called when the Finish button is pressed on the wizard where this page is added.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

AbstractISVWizardPage

public AbstractISVWizardPage()
Constructor for ISVWizardPage. Creates a new ISVWizardPage with no title or image, and with am empty string for the page name.

Method Detail

cacheProperty

public void cacheProperty(String key,
                          String value)
This is used to cache a property and its value for later generating in the metadata file generated by this wizard.
It is important to note here that both key and value are strings. This is only a requirement when setting properties through a wizard page contributed by the ISV property extension point. Once the properties model is generated, it can be manipulated by the IISeriesPropertiesModel API.

Parameters:
key -
value -

removeCachedProperty

public void removeCachedProperty(String key)
Removes this cached property from this wizard's cached property values.

Parameters:
key -

resourceCreated

public void resourceCreated(AbstractISeriesResource iSeriesResource)
This method will be called when the Finish button is pressed on the wizard where this page is added. It is a hook to enable post processing of the created resource after it has been created and added to the iSeries Project Model. By default this method does nothing. Sunclasses may override this behavior. If there are more than one contributed wizard page, they are called sequentially. If any errors occur during this method call, they will be simply logged, and the method returns.

Parameters:
iSeriesResource - The AbstractISeriesResource for the resource that just got created. It will be:
  • an AbstractISeriesProject if this page is contributed to the iSeries Project wizard.
  • an AbstractISeriesNativeObject if this page is contributed to the iSeries Source Physical File wizard.
  • an AbstractISeriesNativeMember if this page is contributed to the iSeries Source Member wizard.

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.