|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
org.eclipse.datatools.connectivity.oda.design.ui.designsession.DataSourceDesignSession
public class DataSourceDesignSession
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 source design instance.
Nested Class Summary | |
---|---|
static interface |
DataSourceDesignSession.IDesignNameValidator
The public interface for call-back to an ODA design name validator provided by an ODA consumer application to validate the name of a data source design defined in the ODA connection profile selection page. |
static class |
DataSourceDesignSession.ProfileReference
Represents the reference information of an external connection profile. |
Nested classes/interfaces inherited from class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase |
---|
org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase.IDesignNameValidatorBase, org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase.ProfileReferenceBase |
Method Summary | |
---|---|
OdaDesignSession |
cancel()
Performs cancel on this design session. |
static OdaDesignSession |
convertDesignToLinkedProfile(DesignSessionRequest request,
java.lang.String newProfileBaseName,
boolean useProfileInDesign,
boolean promptCreateProfileStore,
org.eclipse.swt.widgets.Shell parentShell)
Converts the data source design, in the specified DesignSessionRequest, to export its connection properties to a new connection profile instance, and optionally links to it. |
static OdaDesignSession |
createNewDesignFromProfile(java.lang.String odaDataSourceId,
java.lang.String newDataSourceName,
DataSourceDesignSession.ProfileReference profileRef)
Creates a design session with a new data source design, whose properties and their values are copied from, or referenced to, the given profile reference. |
OdaDesignSession |
finish()
Performs finish on this design session to create or edit its data source design. |
org.eclipse.ui.dialogs.PropertyPage |
getEditorPage()
Returns a customized editor page for use within a design session to edit an extended ODA data source design instance. |
org.eclipse.core.runtime.IAdaptable |
getEditPropertyPageElement()
Returns a customized editor page's adaptable element that represents the the extended ODA data source design instance that is being edited. |
org.eclipse.jface.wizard.IWizard |
getNewWizard()
Returns an ODA wizard for use within this design session to create a new, extended ODA data source design instance. |
org.eclipse.ui.dialogs.PropertyPage |
getProfileSelectionPropertyPage()
Returns the property page that allows an user to update the selection of a connection profile. |
DesignSessionRequest |
getRequest()
Returns the session request that has started this design session. |
org.eclipse.jface.wizard.IWizardPage |
getWizardStartingPage()
Returns a customized starting wizard page for use within this design session to create a new, extended ODA data source design instance. |
void |
restartNewDesign(java.lang.String odaDataSourceId,
java.lang.String newDataSourceName,
DataSourceDesignSession.ProfileReference profileRef,
DesignSessionRequest request)
Restarts the design session to create a new data source design instance with the given name for the given ODA data source type, and initializes with the properties specified in the given profile instance. |
boolean |
setAndVerifyUseProfileSelectionPage()
|
void |
setDesignNameValidator(DataSourceDesignSession.IDesignNameValidator validator)
Assigns the specified design name validator to the wizard page that collects user input of a design name. |
void |
setUseProfileSelectionPage(boolean use)
|
static DataSourceDesignSession |
startEditDesign(DesignSessionRequest request)
Requests to start a design session to edit a data source design, as specified in the given ODA design session request. |
static DataSourceDesignSession |
startEditDesign(DesignSessionRequest request,
DataSourceEditorPage editorPage)
Requests to start a design session with the given editor page to edit a data source design, as specified in the given ODA design session request. |
static DataSourceDesignSession |
startNewDesign(java.lang.String odaDataSourceId,
java.lang.String newDataSourceName)
Starts a design session to create a new data source design instance with the given name for the given ODA data source type. |
static DataSourceDesignSession |
startNewDesign(java.lang.String odaDataSourceId,
java.lang.String newDataSourceName,
DataSourceDesignSession.ProfileReference profileRef,
DesignSessionRequest request)
Starts a design session to create a new data source design instance with the given name for the given ODA data source type, and initializes with the properties specified in the given profile instance. |
static DataSourceDesignSession |
startNewDesignFromProfile()
Starts a design session to create a new data source design instance, whose properties and their values are copied from, or referenced to, the given profile instance reference. |
Methods inherited from class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase |
---|
getNewCustomOdaStartingPage |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static DataSourceDesignSession startNewDesign(java.lang.String odaDataSourceId, java.lang.String newDataSourceName) throws OdaException
odaDataSourceId
- an ODA data source extension element idnewDataSourceName
- a unique name that identifies a
data source design instance
OdaException
startNewDesign(String, String, ProfileReference, DesignSessionRequest)
public static DataSourceDesignSession startNewDesign(java.lang.String odaDataSourceId, java.lang.String newDataSourceName, DataSourceDesignSession.ProfileReference profileRef, DesignSessionRequest request) throws OdaException
odaDataSourceId
- an ODA data source extension element idnewDataSourceName
- a unique name that identifies a
data source design instanceprofileRef
- optional reference to an existing profile instance
kept in an external profile storage file;
may be null if no reference to an existing profilerequest
- optional design session request specification,
such as session's edit state and locale;
may be null for an editable session
in the default system locale
OdaException
public static DataSourceDesignSession startNewDesignFromProfile()
public void restartNewDesign(java.lang.String odaDataSourceId, java.lang.String newDataSourceName, DataSourceDesignSession.ProfileReference profileRef, DesignSessionRequest request) throws OdaException
odaDataSourceId
- newDataSourceName
- profileRef
- request
-
OdaException
startNewDesign(String, String, ProfileReference, DesignSessionRequest)
public static DataSourceDesignSession startEditDesign(DesignSessionRequest request) throws OdaException
request
- a design session request, must contain
a data source design to edit
OdaException
startEditDesign(DesignSessionRequest, DataSourceEditorPage)
public static DataSourceDesignSession startEditDesign(DesignSessionRequest request, DataSourceEditorPage editorPage) throws OdaException
request
- a design session request, must contain
a data source design to editeditorPage
- the property page instance created
by the ODA host to edit the design;
may be null, in which case the session will
create a custom page
OdaException
public static OdaDesignSession createNewDesignFromProfile(java.lang.String odaDataSourceId, java.lang.String newDataSourceName, DataSourceDesignSession.ProfileReference profileRef) throws OdaException
odaDataSourceId
- an ODA data source extension element idnewDataSourceName
- unique name to assign to new data source instance;
may be null or empty, in which case the profile name
is appliedprofileRef
- reference to an existing profile instance
kept in an external profile storage file
OdaException
public static OdaDesignSession convertDesignToLinkedProfile(DesignSessionRequest request, java.lang.String newProfileBaseName, boolean useProfileInDesign, boolean promptCreateProfileStore, org.eclipse.swt.widgets.Shell parentShell) throws OdaException
request
- a design session request, must contain
a valid data source design to convert fromnewProfileBaseName
- optional suggested base name of the new
connection profile; may be null or empty to use the same
name as that of the data source design.
If the suggested name is already used by an existing profile
in the default repository, an unique name will be generated
with a number appended to the base name.useProfileInDesign
- indicates whether to update the data source design
to link to the exported profilepromptCreateProfileStore
- indicates whether to prompt users to
create a separate connection profile storeparentShell
- the parent shell for the UI dialog to create profile store;
must not be null if promptCreateProfileStore is true
OdaException
- if the conversion task failed;
if the data source design in the specified request is already linked to
a connection profile, the cause of thrown exception is an IllegalArgumentExceptionpublic DesignSessionRequest getRequest()
getRequest
in class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
public OdaDesignSession finish() throws OdaException
finish
in class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
OdaException
public OdaDesignSession cancel()
cancel
in class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
public void setUseProfileSelectionPage(boolean use)
setUseProfileSelectionPage
in class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
public boolean setAndVerifyUseProfileSelectionPage()
setAndVerifyUseProfileSelectionPage
in class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
public void setDesignNameValidator(DataSourceDesignSession.IDesignNameValidator validator)
validator
- interface for a call-back validatorpublic org.eclipse.jface.wizard.IWizard getNewWizard() throws OdaException
getNewWizard
in class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
OdaException
public org.eclipse.jface.wizard.IWizardPage getWizardStartingPage() throws OdaException
getWizardStartingPage
in class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
OdaException
public org.eclipse.ui.dialogs.PropertyPage getProfileSelectionPropertyPage() throws OdaException
OdaException
public org.eclipse.ui.dialogs.PropertyPage getEditorPage() throws OdaException
getEditorPage
in class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
OdaException
public org.eclipse.core.runtime.IAdaptable getEditPropertyPageElement() throws OdaException
getEditPropertyPageElement
in class org.eclipse.datatools.connectivity.oda.design.internal.designsession.DataSourceDesignSessionBase
OdaException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |