public interface IConfiguredSite extends IAdaptable
Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
| Modifier and Type | Method and Description |
|---|---|
void |
addConfiguredSiteChangedListener(IConfiguredSiteChangedListener listener)
Adds a change listener to the configured site.
|
void |
configure(IFeature feature)
Configure the specified feature on this site.
|
IStatus |
getBrokenStatus(IFeature feature)
Indicates if the specified feature is "broken".
|
IFeatureReference[] |
getConfiguredFeatures()
Return references to features configured on this site.
|
IFeatureReference[] |
getFeatureReferences()
Return all features installed on this site (configured as well
as unconfigured).
|
IInstallConfiguration |
getInstallConfiguration()
Returns the install configuration object this site is part of.
|
ISite |
getSite()
Returns the underlying "unfiltered" site.
|
IFeatureReference |
install(IFeature feature,
IFeatureReference[] optionalFeatures,
IVerificationListener verificationListener,
IProgressMonitor monitor)
Install the specified feature on this site.
|
IFeatureReference |
install(IFeature feature,
IVerificationListener verificationListener,
IProgressMonitor monitor)
Install the specified feature on this site.
|
boolean |
isConfigured(IFeature feature)
Indicates if the specified feature is configured on this site.
|
boolean |
isEnabled()
Indicates if the site is enabled.
|
boolean |
isExtensionSite()
Indicates if the site is an extension site.
|
boolean |
isNativelyLinked()
Indicates if the site has been linked by a native
installer.
|
boolean |
isPrivateSite()
Deprecated.
private site are considered the same as extension site (3.0)
|
boolean |
isProductSite()
Indicates if the site is a product site.
|
boolean |
isUpdatable()
Indicates whether updates can be applied to the site.
|
void |
remove(IFeature feature,
IProgressMonitor monitor)
Remove (uninstall) the specified feature from this site
|
void |
removeConfiguredSiteChangedListener(IConfiguredSiteChangedListener listener)
Removes a change listener from the configured site.
|
void |
setEnabled(boolean value)
Sets if the site is enabled
|
boolean |
unconfigure(IFeature feature)
Unconfigure the specified feature from this site.
|
IStatus |
verifyUpdatableStatus()
Indicates whether updates can be applied to the site.
|
getAdapterISite getSite()
Note: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
IStatus verifyUpdatableStatus()
IStatus.isOk() return true if
the site can be updated, false otherwise.
If updates cannot be aplied, the status contains the error message, and
the possible exception.Note: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
IStatusboolean isUpdatable()
true if the site can be updated,
false otherwiseNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
IFeatureReference install(IFeature feature, IVerificationListener verificationListener, IProgressMonitor monitor) throws CoreException
feature - feature to installverificationListener - verification listener, or nullmonitor - progress monitor, or nullCoreExceptionNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
IFeatureReference install(IFeature feature, IFeatureReference[] optionalFeatures, IVerificationListener verificationListener, IProgressMonitor monitor) throws CoreException
feature - feature to installoptionalFeatures - optional features to installverificationListener - verification listener, or nullmonitor - progress monitor, or nullCoreExceptionNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
void remove(IFeature feature, IProgressMonitor monitor) throws CoreException
feature - feature to removemonitor - progress monitor, or nullCoreExceptionNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
IStatus getBrokenStatus(IFeature feature)
IStatus.ERROR if the feature is considered
broken. The Status may contain the reason why the feature is broken.
The status code is IStatus.OK if the feature is not considered
broken.feature - the featureNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
boolean isConfigured(IFeature feature)
feature - the featuretrue if the feature is configured,
false otherwiseNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
void configure(IFeature feature) throws CoreException
feature - the featureCoreExceptionNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
boolean unconfigure(IFeature feature) throws CoreException
feature - the featureCoreExceptionNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
IFeatureReference[] getConfiguredFeatures()
Note: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
IFeatureReference[] getFeatureReferences()
Note: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
ISite.getFeatureReferences()IInstallConfiguration getInstallConfiguration()
Note: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
void addConfiguredSiteChangedListener(IConfiguredSiteChangedListener listener)
listener - the listener to addNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
void removeConfiguredSiteChangedListener(IConfiguredSiteChangedListener listener)
listener - the listener to removeNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
boolean isExtensionSite()
true if the site is an extension site,
false otherwiseNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
boolean isProductSite()
true if the site is a product site,
false otherwiseNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
boolean isPrivateSite()
true if the site is a private site,
false otherwiseNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
boolean isNativelyLinked()
throws CoreException
true if the site is a natively linked site,
false otherwiseCoreExceptionNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
void setEnabled(boolean value)
value - true if the site is enable, false
otherwiseNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
boolean isEnabled()
true if the site is enable, false
otherwiseNote: This method is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.