Eclipse Platform
Release 3.6

org.eclipse.equinox.p2.engine
Interface IProvisioningPlan


public interface IProvisioningPlan

A provisioning plan describes a proposed set of changes to a profile. The proposed changes may represent a valid and consistent set of changes, or it may represent a set of changes that would cause errors if executed. In this case the plan contains information about the severity and explanation for the problems.

Since:
2.0

Method Summary
 void addInstallableUnit(IInstallableUnit iu)
           
 IQueryable<IInstallableUnit> getAdditions()
          Returns the proposed set of installable units to be added to the profile.
 ProvisioningContext getContext()
          Returns the provisioning context in which this plan was created.
 IProvisioningPlan getInstallerPlan()
          Returns a plan describing the proposed set of changes to the provisioning infrastructure required by this plan.
 IProfile getProfile()
          Returns the profile that this plan will operate on.
 IQueryable<IInstallableUnit> getRemovals()
          Returns the proposed set of installable units to be removed from this profile.
 IStatus getStatus()
          Returns the overall plan status.
 void removeInstallableUnit(IInstallableUnit iu)
           
 void setInstallableUnitProfileProperty(IInstallableUnit iu, String name, String value)
           
 void setInstallerPlan(IProvisioningPlan installerPlan)
           
 void setProfileProperty(String name, String value)
           
 void setStatus(IStatus status)
           
 void updateInstallableUnit(IInstallableUnit iu1, IInstallableUnit iu2)
           
 

Method Detail

getAdditions

IQueryable<IInstallableUnit> getAdditions()
Returns the proposed set of installable units to be added to the profile.

Returns:
The proposed profile additions

getContext

ProvisioningContext getContext()
Returns the provisioning context in which this plan was created.

Returns:
The plan's provisioning context

getInstallerPlan

IProvisioningPlan getInstallerPlan()
Returns a plan describing the proposed set of changes to the provisioning infrastructure required by this plan. The installer changes must be performed before this plan can be successfully executed.

Returns:
The installer plan.

setInstallerPlan

void setInstallerPlan(IProvisioningPlan installerPlan)

getProfile

IProfile getProfile()
Returns the profile that this plan will operate on.

Returns:
The target profile for this plan

getRemovals

IQueryable<IInstallableUnit> getRemovals()
Returns the proposed set of installable units to be removed from this profile.

Returns:
The proposed profile removals.

getStatus

IStatus getStatus()
Returns the overall plan status. The severity of this status indicates whether the plan can be successfully executed or not:

Returns:
The overall plan status.

setStatus

void setStatus(IStatus status)

addInstallableUnit

void addInstallableUnit(IInstallableUnit iu)

removeInstallableUnit

void removeInstallableUnit(IInstallableUnit iu)

updateInstallableUnit

void updateInstallableUnit(IInstallableUnit iu1,
                           IInstallableUnit iu2)

setProfileProperty

void setProfileProperty(String name,
                        String value)

setInstallableUnitProfileProperty

void setInstallableUnitProfileProperty(IInstallableUnit iu,
                                       String name,
                                       String value)

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.