com.ibm.etools.iseries.rse.ui.wizard.cmds
Class AbstractNewQSYSObjectWizard

java.lang.Object
  AbstractSystemWizard
      com.ibm.etools.iseries.rse.ui.wizard.cmds.AbstractNewQSYSObjectWizard

Direct Known Subclasses:

NewQSYSDataAreaWizard, NewQSYSDataQWizard, NewQSYSLibraryWizard, NewQSYSMemberWizard, NewQSYSMsgFileWizard, NewQSYSSourceFileWizard

public abstract class AbstractNewQSYSObjectWizard
extends AbstractSystemWizard

Abstract base class for wizards for creating various types of new iSeries objects. This is the resulting of noticing much redundancy across these wizards.

Field Summary

protected AbstractNewQSYSObjectWizardAdvPage	advPage
protected String	canonicalNewObjectName
protected String	cmdString
protected IBMiConnection	conn400
static String	copyright
protected boolean	filterSelected
protected boolean	fromFileNew
protected AbstractNewQSYSObjectWizardMainPage	mainPage
protected String	newObjNameType
protected NewQSYSObjectWizardOptionsPage	optsPage
protected String	outLibName
protected String	outObjAut
protected String	outObjName
protected String	outObjText

Constructor Summary

protected

AbstractNewQSYSObjectWizard(IBMiConnection conn400, String title, String tooltip, String imageID, boolean fromFileNew) Constructor when called from within the RSE, via our action

Method Summary

void	addPages() Creates the wizard pages.
protected abstract AbstractNewQSYSObjectWizardAdvPage	createAdvancedPage() Creates the wizard's advanced page.
protected abstract AbstractNewQSYSObjectWizardMainPage	createMainPage() Creates the wizard's main page.
protected abstract NewQSYSObjectWizardOptionsPage	createOptionsPage() Creates the wizard's options page.
protected boolean	disableContainerPrompts() Disable contain prompts if given input names?
protected boolean	doPerformFinish(String cmdString) This is called by the base class's performFinish method, to enable overriding by child classes
protected String	getAbsoluteName() Return the absolute name from the current values in the wizard pages
protected String	getAbsoluteNameForFilterTesting() Return the absolute name from the current values in the wizard pages.
protected String	getAbsoluteParentName() Return the absolute name of the parent remote object
String	getAuthority() Get Authority parameter value
String	getCanonicalName() Get the canonical name of the newly created object.
String	getCommandString() Get the resulting command string that was executed remotely
protected ISystemTree	getCurrentTreeView() Return the current viewer as an ISystemTree if it is one, or null otherwise.
protected IHost	getHost() Get the input connection if there is one
String	getLibraryName() Get library name
String	getObjectName() Get object name
String	getObjectText() Get text for the new object
protected abstract String	getObjectType() Get the object type, as in *DTAQ
protected AbstractNewQSYSObjectWizardMainPage	getPage1() Get the first page
protected AbstractNewQSYSObjectWizardAdvPage	getPage2() Get the second page
protected boolean	meetsFilterCriteria(SystemFilterReference selectedFilterRef, String newAbsName) Test if the new object will meet the filtering criteria of the selected filter
boolean	performFinish() Completes processing of the wizard.
void	setAuthority(String aut) Set Authority parameter value
void	setConnection(IHost connection) Set the connection, given a system connection.
void	setLibraryName(String lib) Set library name
void	setObjectName(String file) Set object name
void	setObjectText(String text) Set text for the new object

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

mainPage

protected AbstractNewQSYSObjectWizardMainPage mainPage

advPage

protected AbstractNewQSYSObjectWizardAdvPage advPage

optsPage

protected NewQSYSObjectWizardOptionsPage optsPage

conn400

protected IBMiConnection conn400

fromFileNew

protected boolean fromFileNew

filterSelected

protected boolean filterSelected

cmdString

protected String cmdString

canonicalNewObjectName

protected String canonicalNewObjectName

newObjNameType

protected String newObjNameType

outLibName

protected String outLibName

outObjName

protected String outObjName

outObjText

protected String outObjText

outObjAut

protected String outObjAut

Constructor Detail

AbstractNewQSYSObjectWizard

protected AbstractNewQSYSObjectWizard(IBMiConnection conn400,
                                      String title,
                                      String tooltip,
                                      String imageID,
                                      boolean fromFileNew)

Constructor when called from within the RSE, via our action

Method Detail

getCurrentTreeView

protected ISystemTree getCurrentTreeView()

Return the current viewer as an ISystemTree if it is one, or null otherwise. Override of parent method: for these actions which can come from File->New, we test to see if they are launched from the RSE perspective, and if so get the tree from it:

addPages

public void addPages()

Creates the wizard pages. This method is an override from the parent Wizard class.

getHost

protected IHost getHost()

Get the input connection if there is one

performFinish

public boolean performFinish()

Completes processing of the wizard. If this method returns true, the wizard will close; otherwise, it will stay active. This method is an override from the parent Wizard class.

For most wizards this can be used as is, but if unique processing is required, override doPerformFinish(). It is only called after successfully calling performFinish on both the main and the advanced pages.

Returns:

whether the wizard finished successfully

getAbsoluteName

protected String getAbsoluteName()

Return the absolute name from the current values in the wizard pages

getAbsoluteNameForFilterTesting

protected String getAbsoluteNameForFilterTesting()

Return the absolute name from the current values in the wizard pages. This overload is for testing for current-filter matching, so potentially needs more information.

getAbsoluteParentName

protected String getAbsoluteParentName()

Return the absolute name of the parent remote object

meetsFilterCriteria

protected boolean meetsFilterCriteria(SystemFilterReference selectedFilterRef,
                                      String newAbsName)

Test if the new object will meet the filtering criteria of the selected filter

doPerformFinish

protected boolean doPerformFinish(String cmdString)
                           throws Exception

This is called by the base class's performFinish method, to enable overriding by child classes

Returns:

whether the wizard finished successfully

Throws:

Exception

getPage1

protected AbstractNewQSYSObjectWizardMainPage getPage1()

Get the first page

getPage2

protected AbstractNewQSYSObjectWizardAdvPage getPage2()

Get the second page

disableContainerPrompts

protected boolean disableContainerPrompts()

Disable contain prompts if given input names?

setConnection

public void setConnection(IHost connection)

Set the connection, given a system connection. This can be called later if null is passed in the constructor

setLibraryName

public void setLibraryName(String lib)

Set library name

setObjectName

public void setObjectName(String file)

Set object name

setObjectText

public void setObjectText(String text)

Set text for the new object

setAuthority

public void setAuthority(String aut)

Set Authority parameter value

getLibraryName

public String getLibraryName()

Get library name

getObjectName

public String getObjectName()

Get object name

getObjectText

public String getObjectText()

Get text for the new object

getAuthority

public String getAuthority()

Get Authority parameter value

getCommandString

public String getCommandString()

Get the resulting command string that was executed remotely

getCanonicalName

public String getCanonicalName()

Get the canonical name of the newly created object. This will be sufficiently qualified to uniquely identify it. Eg, will include library, name and object type.

createMainPage

protected abstract AbstractNewQSYSObjectWizardMainPage createMainPage()

Creates the wizard's main page.

createAdvancedPage

protected abstract AbstractNewQSYSObjectWizardAdvPage createAdvancedPage()

Creates the wizard's advanced page.

createOptionsPage

protected abstract NewQSYSObjectWizardOptionsPage createOptionsPage()

Creates the wizard's options page. This is a standard final page in all the New resource wizards for iSeries.

getObjectType

protected abstract String getObjectType()

Get the object type, as in *DTAQ