|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
void |
addInstallableUnit(IInstallableUnit iu)
Adds an installable unit to the plan. |
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)
Removes an installable unit from the plan. |
void |
setInstallableUnitProfileProperty(IInstallableUnit iu,
String name,
String value)
Adds a profile property corresponding to the given installable unit to the plan. |
void |
setInstallerPlan(IProvisioningPlan installerPlan)
Sets the installer plan for this plan. |
void |
setProfileProperty(String name,
String value)
Sets a profile property in the plan. |
void |
setStatus(IStatus status)
Sets the overall plan status, describing whether the planner constructing this plan believes it will install successfully, or whether it contains errors or the plan computation has been canceled. |
void |
updateInstallableUnit(IInstallableUnit from,
IInstallableUnit to)
Adds an instruction to replace one installable unit in the profile with another. |
Method Detail |
---|
IQueryable<IInstallableUnit> getAdditions()
ProvisioningContext getContext()
IProvisioningPlan getInstallerPlan()
IProfile getProfile()
IQueryable<IInstallableUnit> getRemovals()
IStatus getStatus()
IStatus.OK
indicates that the plan can be executed successfully.IStatus.INFO
or IStatus.WARNING
indicates
that the plan can be executed but may cause problems.IStatus.ERROR
indicates that the plan cannot be executed
successfully.IStatus.CANCEL
indicates that the plan computation was
canceled and is incomplete. A canceled plan cannot be executed.
void addInstallableUnit(IInstallableUnit iu)
This is an advanced operation that should only be performed by clients crafting their own custom plan. Most clients should instead use a planner service to construct a valid plan based on a profile change request.
iu
- the installable unit to addvoid removeInstallableUnit(IInstallableUnit iu)
This is an advanced operation that should only be performed by clients crafting their own custom plan. Most clients should instead use a planner service to construct a valid plan based on a profile change request.
iu
- the installable unit to addvoid setInstallableUnitProfileProperty(IInstallableUnit iu, String name, String value)
This is an advanced operation that should only be performed by clients crafting their own custom plan. Most clients should instead use a planner service to construct a valid plan based on a profile change request.
iu
- the installable unit to set a property forname
- the property namevalue
- the property valuevoid setInstallerPlan(IProvisioningPlan installerPlan)
This is an advanced operation that should only be performed by clients crafting their own custom plan. Most clients should instead use a planner service to construct a valid plan based on a profile change request.
installerPlan
- the plan describing changes to the provisioning agentvoid setProfileProperty(String name, String value)
This is an advanced operation that should only be performed by clients crafting their own custom plan. Most clients should instead use a planner service to construct a valid plan based on a profile change request.
name
- the profile property namevalue
- the profile property valuevoid setStatus(IStatus status)
This is an advanced operation that should only be performed by clients crafting their own custom plan. Most clients should instead use a planner service to construct a valid plan based on a profile change request.
status
- the plan statusvoid updateInstallableUnit(IInstallableUnit from, IInstallableUnit to)
This is an advanced operation that should only be performed by clients crafting their own custom plan. Most clients should instead use a planner service to construct a valid plan based on a profile change request.
from
- the installable unit to removeto
- the installable unit to add
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.