IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.recorder.ui.wizards
Interface INewRecordingSessionWizard

All Superinterfaces:
INewWizard, IWizard, IWorkbenchWizard

public interface INewRecordingSessionWizard
extends INewWizard

Interface for programmatically accessing the "New Recording Session" wizard.

See Also:
RecorderUi.createNewRecordingSessionWizard()

Method Summary
 IRecordingSession getRecordingSession()
          Returns the recording session that was launched by the wizard, if any.
 void setClientEntry(RecorderClientWizardConfigurer.ClientEntry clientEntry)
          Sets the client entry to use.
 void setInputConfiguration(RecordingSessionConfiguration inputConfiguration, IFile inputConfigurationFile)
          Sets the recording session configuration to be used.
 void setRecordingSessionFile(IFile file, com.ibm.rational.test.lt.recorder.core.encrypt.EncryptionLevel encryptionMethod)
          Sets the file where the recording session will be persisted.
 void setRestriction(RecorderClientWizardConfigurer configurer)
          Forces the wizard to present only a subset of clients and recorders as specified by the configurer.
 
Methods inherited from interface org.eclipse.ui.IWorkbenchWizard
init
 
Methods inherited from interface org.eclipse.jface.wizard.IWizard
addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, performFinish, setContainer
 

Method Detail

setInputConfiguration

void setInputConfiguration(RecordingSessionConfiguration inputConfiguration,
                           IFile inputConfigurationFile)
Sets the recording session configuration to be used. If not null, the wizard will only prompt the user for selecting the session location and name, and skip any configuration page.

Parameters:
inputConfiguration - A recording session configuration, or null.
inputConfigurationFile - The file that contains the recording session, be it a recording session configuration file (.recconfig) or a recording session (.recsession). This argument must be null if inputConfiguration is null, and must not be null if inputConfiguration is not null.

setClientEntry

void setClientEntry(RecorderClientWizardConfigurer.ClientEntry clientEntry)
Sets the client entry to use. If not null, the wizard will skip the client selection page.

Parameters:
clientEntry - A client entry.

setRecordingSessionFile

void setRecordingSessionFile(IFile file,
                             com.ibm.rational.test.lt.recorder.core.encrypt.EncryptionLevel encryptionMethod)
Sets the file where the recording session will be persisted. If not null, the name and location page will be skipped. In this case, the user won't be able to select any pre-defined configuration.

Parameters:
file -
encryptionMethod -

setRestriction

void setRestriction(RecorderClientWizardConfigurer configurer)
Forces the wizard to present only a subset of clients and recorders as specified by the configurer.

Parameters:
configurer - A recording wizard configurer.
See Also:
RecorderClientWizardConfigurer.newConfigurer(Set, Set, Set)

getRecordingSession

IRecordingSession getRecordingSession()
Returns the recording session that was launched by the wizard, if any.

Returns:
The recording session that was launched by the wizard, if any. This value is always null if IWizard.performFinish() has not been called, and may still be null if the recording session could not be created.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.