# Service policy UI

###### Identifier:

org.eclipse.wst.service.policy.ui.servicePolicyUI

###### Since:

1.0

###### Description:

This extension allows extenders to add service policy UI operations for the service policies that they have added.

###### Configuration Markup:

<!ELEMENT extension (servicePolicyUI+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT servicePolicyUI (operation* | quickFix*)>

This extension is intended for extenders who want to add UI operations to the Service policies that they have defined.

<!ELEMENT descriptor EMPTY>

<!ATTLIST descriptor

description CDATA #IMPLIED

shortName CDATA #IMPLIED

longName CDATA #IMPLIED

contextHelpId CDATA #IMPLIED

iconpath CDATA #IMPLIED>

A descriptor for this Service policy operation or action.

- description - A description of this service operation.
- shortName - The short name of this service operation. Note: if a short name is not specified it is defaulted to the value of the long name.
- longName - The long name of this service operation. Note: if a long name attribute is not specified it is defaulted to the shortName value.
- contextHelpId - The context help id for this service operation if it is required.
- iconpath - A plugin relative path to some icon file for this service operation.

<!ELEMENT operation (descriptor , enabled? , (enumeration | selection | complex))>

<!ATTLIST operation

id CDATA #REQUIRED

policyPattern CDATA #REQUIRED

workspaceOnly (true | false)

defaultdata (true | false) "true">

Defines a Service policy operation.

- id - This unique id of this service operation.
- policyPattern - The attribute specifies which service polices this operation is associated with. Any Java regular expression may be specified. This expression will be used to match the ids of all known service policy ids.
- workspaceOnly - This attribute indicates if this operation is only to be used in the workspace preference page. If this attribute is not specified it is defaulted to false.
- defaultdata -

<!ELEMENT enumeration EMPTY>

<!ATTLIST enumeration

id CDATA #REQUIRED

defaultItem CDATA #IMPLIED>

This element defines the enumeration that this operation is associated with.

- id - The id of this enumeration.
- defaultItem - Overrides the default set by the enumeration.

<!ELEMENT selection EMPTY>

<!ATTLIST selection

icon (true | false) >

This element indicates that the service policy operation is associated with a some kind of UI boolean selection. All service policies that are associated with this operation should use the org.eclipse.wst.service.policy.booleanEnum enumeration.

- icon - This boolean attribute indicates that the boolean selection should be rendered via an icon.

<!ELEMENT complex EMPTY>

<!ATTLIST complex

launchClass CDATA #REQUIRED>

This element indicates that this operation is complex to render and persist. The launchClass attribute can be used to launch a dialog to set more complex data. The extender will need to call the service policy platform API to persist data on each policy as required.

- launchClass - A class that can be used to launch a dialog. The class specified must implement the ILaunchOperation interface.

<!ELEMENT enabled EMPTY>

<!ATTLIST enabled

enabledClass CDATA #IMPLIED

multiselect CDATA #IMPLIED>

Indicates if this operation is enabled/grayed out or not in the UI.

- enabledClass - The class specified in the attribute much implement the IEnableOperation interface. This class allows extenders to provide a more complex logic for when the operation should be enabled or not.
- multiselect - Indicates if this operation allows multiple selection of policy objects or not.

<!ELEMENT quickFix (action+)>

<!ATTLIST quickFix

pluginId CDATA #REQUIRED

code CDATA #REQUIRED>

This element allows extenders to add quick fixes to the Service policy UI frameworks.

- pluginId - The plugin id that the enclosed quick fix actions apply to. This is the id that will match the plugin id from the IStatus of a ServicePolicy object.
- code - The code that the enclosed quick fix actions apply to. This is the code that will match the code from the IStatus of a ServicePolicy object.

<!ELEMENT action (descriptor)>

<!ATTLIST action

class CDATA #REQUIRED>

The element is used to add a quick fix action.

- class - The class that the framework will call for a particular quick fix action. This class must implement the IQuickFixAction interface.

###### Examples:

[Enter extension point usage example here.]

###### Supplied Implementation:

[Enter information about supplied implementation of this extension point.]