|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectDataSetDesignSessionBase
org.eclipse.datatools.connectivity.oda.design.ui.designsession.DataSetDesignSession
An UI design session for use by an ODA host designer to interact and communicate with custom ODA UI extensions to create or edit an extended ODA data set design instance.
Method Summary | |
OdaDesignSession |
cancel()
Performs cancel on this design session. |
OdaDesignSession |
finish()
Performs finish on this design session to create or edit its data set design. |
IAdaptable |
getEditorPageElement()
Returns a customized editor page's adaptable element that represents the the extended ODA data set design instance that is being edited. |
DataSetEditorPage[] |
getEditorPages()
Returns an ordered collection of customized editor pages for use within a design session to edit an extended ODA data set design instance. |
IWizard |
getNewWizard()
Returns an ODA wizard for use within this design session to create a new, extended ODA data set design instance. |
DesignSessionRequest |
getRequest()
Returns the session request that has started this design session. |
IWizardPage |
getWizardStartingPage()
Returns a customized starting wizard page for use within this design session to create or edit an extended ODA data set design instance. |
void |
restartNewDesign(java.lang.String newDataSetName,
java.lang.String odaDataSetId,
DataSourceDesign dataSourceDesign)
Restarts the design session to create a new data set design instance with the given name for the given ODA data set type. |
static DataSetDesignSession |
startEditDesign(DesignSessionRequest request)
Requests to start a design session to create or edit a data set design, as specified in the given ODA design session request. |
static DataSetDesignSession |
startNewDesign(java.lang.String newDataSetName,
java.lang.String odaDataSetId,
DataSourceDesign dataSourceDesign)
Starts a design session to create a new data set design instance with the given name. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static DataSetDesignSession startNewDesign(java.lang.String newDataSetName, java.lang.String odaDataSetId, DataSourceDesign dataSourceDesign) throws OdaException
newDataSetName
- a unique name that identifies a data set
design instanceodaDataSetId
- an ODA data set element id;
may be null if the associated data source extension
supports only one type of data setdataSourceDesign
- the associated data source design instance
OdaException
public void restartNewDesign(java.lang.String newDataSetName, java.lang.String odaDataSetId, DataSourceDesign dataSourceDesign) throws OdaException
newDataSetName
- a unique name that identifies a data set
design instanceodaDataSetId
- an ODA data set element id;
may be null if the associated data source extension
supports only one type of data setdataSourceDesign
- the associated data source design instance
OdaException
public static DataSetDesignSession startEditDesign(DesignSessionRequest request) throws OdaException
request
- a design session request, may contain
a data set design to edit
OdaException
public DesignSessionRequest getRequest()
public OdaDesignSession finish() throws OdaException
OdaException
public OdaDesignSession cancel()
public IWizard getNewWizard() throws OdaException
OdaException
public IWizardPage getWizardStartingPage() throws OdaException
OdaException
public DataSetEditorPage[] getEditorPages() throws OdaException
OdaException
public IAdaptable getEditorPageElement() throws OdaException
OdaException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |