|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.equinox.p2.ui.Policy
public class Policy
The Policy class is used to specify application specific policies that should be used in the standard p2 UI class libraries. The default policy is acquired using the OSGi service model. Policy allows clients to specify things such as how repositories are manipulated in the standard wizards and dialogs, and how the repositories or the installation itself should be traversed when displaying content. In some cases, the Policy is used only to define a default value that can be overridden by user choice and subsequently stored in dialog settings. Client applications should ensure that their Policy is registered before any of the p2 UI objects access the default Policy.
Field Summary | |
---|---|
static int |
RESTART_POLICY_FORCE
A constant indicating that restart should be forced (without confirmation) immediately after completion of a provisioning operation. |
static int |
RESTART_POLICY_FORCE_APPLY
A constant indicating that the changes should be applied dynamically to the profile (without confirmation) immediately after completion of a provisioning operation. |
static int |
RESTART_POLICY_PROMPT
A constant indicating that the user should be prompted to restart after completion of a provisioning operation. |
static int |
RESTART_POLICY_PROMPT_RESTART_OR_APPLY
A constant indicating that, where possible, the user should be given the option to restart or dynamically apply the changes after completion of a provisioning operation. |
Constructor Summary | |
---|---|
Policy()
|
Method Summary | |
---|---|
boolean |
continueWorkingWithOperation(ProfileChangeOperation operation,
Shell shell)
Answer a boolean indicating whether the caller should continue to work with the specified operation. |
boolean |
getGroupByCategory()
Return a boolean indicating whether available software should be grouped by category. |
IStatus |
getNoProfileChosenStatus()
Return a status that can be used to describe the failure to retrieve a profile. |
boolean |
getRepositoriesVisible()
Return a boolean indicating whether the repositories should be visible to the user, such that the user can add, remove, and otherwise manipulate the software site list. |
String |
getRepositoryPreferencePageId()
Get the id of the preference page that should be used to link to the software sites page. |
String |
getRepositoryPreferencePageName()
Get the localized name of the preference page that should be displayed in links to the software sites page. |
int |
getRestartPolicy()
Get the restart policy that should be used when the provisioning UI determines that a restart is required. |
boolean |
getShowDrilldownRequirements()
Return a boolean indicating whether the user should be allowed drill down from a visible update or installed item into the requirements. |
boolean |
getShowLatestVersionsOnly()
Return a boolean indicating whether only the latest versions of updates and available software should be shown to the user. |
IQuery<IInstallableUnit> |
getVisibleAvailableIUQuery()
Return a query that can be used to obtain the IInstallableUnits that should be presented to the user from the software repositories. |
IQuery<IInstallableUnit> |
getVisibleInstalledIUQuery()
Return a query that can be used to obtain the IInstallableUnits in the profile that should be presented to the user. |
void |
setGroupByCategory(boolean group)
Set a boolean indicating whether available software should be grouped by category. |
void |
setRepositoriesVisible(boolean visible)
Set a boolean indicating whether the repositories should be visible to the user, such that the user can add, remove, and otherwise manipulate the software site list. |
void |
setRepositoryPreferencePageId(String id)
Set the id of the preference page that should be used to link to the software sites page. |
void |
setRepositoryPreferencePageName(String name)
Set the localized name of the preference page that should be displayed in links to the software sites page. |
void |
setRestartPolicy(int restartPolicy)
Set the restart policy that should be used when the provisioning UI determines that a restart is required. |
void |
setShowDrilldownRequirements(boolean drilldown)
Set a boolean indicating whether the user should be allowed drill down from a visible update or installed item into the requirements. |
void |
setShowLatestVersionsOnly(boolean showLatest)
Set a boolean indicating whether only the latest versions of updates and available software should be shown to the user. |
void |
setVisibleAvailableIUQuery(IQuery<IInstallableUnit> query)
Set the query that can be used to obtain the IInstallableUnits that should be presented to the user. |
void |
setVisibleInstalledIUQuery(IQuery<IInstallableUnit> query)
Set the query that can be used to obtain the IInstallableUnits in the profile that should be presented to the user. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int RESTART_POLICY_FORCE
public static final int RESTART_POLICY_FORCE_APPLY
public static final int RESTART_POLICY_PROMPT
public static final int RESTART_POLICY_PROMPT_RESTART_OR_APPLY
Constructor Detail |
---|
public Policy()
Method Detail |
---|
public boolean continueWorkingWithOperation(ProfileChangeOperation operation, Shell shell)
operation
- the operation in question. It must already be resolved.shell
- the shell to use for any interaction with the user
true
if processing of the operation should continue, false
if
not. It is up to the implementor to report any errors to the user when answering false
.public IStatus getNoProfileChosenStatus()
null
if there is no such status.public IQuery<IInstallableUnit> getVisibleAvailableIUQuery()
public void setVisibleAvailableIUQuery(IQuery<IInstallableUnit> query)
query
- the query used to retrieve user visible available IUspublic IQuery<IInstallableUnit> getVisibleInstalledIUQuery()
public void setVisibleInstalledIUQuery(IQuery<IInstallableUnit> query)
query
- the query used to retrieve user visible installed IUspublic int getRestartPolicy()
RESTART_POLICY_FORCE
,
RESTART_POLICY_FORCE_APPLY
,
RESTART_POLICY_PROMPT
,
RESTART_POLICY_PROMPT_RESTART_OR_APPLY
public void setRestartPolicy(int restartPolicy)
restartPolicy
- an integer constant describing the restart policyRESTART_POLICY_FORCE
,
RESTART_POLICY_FORCE_APPLY
,
RESTART_POLICY_PROMPT
,
RESTART_POLICY_PROMPT_RESTART_OR_APPLY
public boolean getRepositoriesVisible()
true
if repositories are visible to the end
user, false
if they are not.public void setRepositoriesVisible(boolean visible)
visible
- true
if repositories are visible to the end
user, false
if they are not.public boolean getShowLatestVersionsOnly()
true
if only the latest versions are shown,
false
if all versions should be shown.public void setShowLatestVersionsOnly(boolean showLatest)
showLatest
- true
if only the latest versions are shown,
false
if all versions should be shown.public boolean getShowDrilldownRequirements()
true
if drilldown is allowed,
false
if it is not.public void setShowDrilldownRequirements(boolean drilldown)
drilldown
- true
if drilldown is allowed,
false
if it is not.public boolean getGroupByCategory()
true
if items should be grouped by category,
false
if categories should not be shown.public void setGroupByCategory(boolean group)
group
- true
if items should be grouped by category,
false
if categories should not be shown.public String getRepositoryPreferencePageId()
null
if there is no
preference page id showing the software sites.public void setRepositoryPreferencePageId(String id)
id
- the preference page id, or null
if there is no
preference page id showing the software sites.public String getRepositoryPreferencePageName()
null
if there is no
preference page.public void setRepositoryPreferencePageName(String name)
name
- the preference page name, or null
if there is no
preference page.setRepositoryPreferencePageId(String)
|
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.