|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.datatools.connectivity.oda.design.ui.manifest.DataSetUIElement
public class DataSetUIElement
Represents the definition of customized data set designer that an ODA data provider extends to allow an user to create or edit an ODA data set design instance. This encapsulates the child elements for the data set wizard page(s) and editor page(s).
Method Summary | |
---|---|
IConfigurationElement |
getElement()
Returns the configuration element of this instance. |
java.lang.String |
getId()
Returns the fully qualified ID that uniquely identifies the ODA data set type within an ODA data source extension. |
java.lang.String |
getInitialPageId()
Returns the id of a dataSetPage that should be selected and have initial focus in a preference dialog. |
DataSetPageInfo |
getPageDefinition(java.lang.String pageId)
Returns the DataSetPageInfo instance that represents the dataSetPage element with the given id defined in this data set ui element. |
DataSetPageInfo[] |
getPageDefinitions()
Returns an array of definitions of customized data set pages that an extension contributes to an ODA host designer's data set dialog. |
static IConfigurationElement |
getPageElement(IConfigurationElement dataSetUIElement,
java.lang.String pageId)
Returns the dataSetPage configuration element with the given page id defined in this data set ui element. |
java.lang.String[] |
getPageIds()
Returns an array of ids of the dataSetPage elements defined in this data set ui element. |
static IConfigurationElement |
getWizardElement(IConfigurationElement dataSetUIElement)
Returns the dataSetWizard configuration element that defines the wizard that allows an user to create a new ODA data set design instance. |
DataSetWizardInfo |
getWizardInfo()
Returns the definition of a data set wizard that allows an user to create a new ODA data set design instance. |
boolean |
supportsInParameters()
Indicates that this type of data set design supports input parameter definitions, and that an ODA host designer might need to collect further metadata on the parameter definitions provided by the customized page(s). |
boolean |
supportsOutParameters()
Indicates that this type of data set design supports output parameter definitions, and that an ODA host designer might need to collect further metadata on the parameter definitions provided by the customized page(s). |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.lang.String getId()
public java.lang.String getInitialPageId()
public boolean supportsInParameters()
public boolean supportsOutParameters()
public IConfigurationElement getElement()
public DataSetWizardInfo getWizardInfo()
public static IConfigurationElement getWizardElement(IConfigurationElement dataSetUIElement) throws OdaException
dataSetUIElement
- a dataSetUI configuration element
OdaException
- if no dataSetWizard element is definedpublic DataSetPageInfo[] getPageDefinitions()
public java.lang.String[] getPageIds()
public DataSetPageInfo getPageDefinition(java.lang.String pageId) throws OdaException
pageID
- the id of a data set page element
OdaException
- if no data set page id is specified, and
there are more than one data set pages;
or when no match is found for given page idpublic static IConfigurationElement getPageElement(IConfigurationElement dataSetUIElement, java.lang.String pageId) throws OdaException
dataSetUIElement
- a dataSetUI configuration elementpageID
- the id of a data set page element
OdaException
- if no data set page id is specified, and
there are more than one data set pages
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |