This droplet removes markers from a repository item. Markers are identified by matching key, value, data and extendedProperties. All provided values must match for the marker to be removed. An extended property map can be provided either by droplet input parameters or by extending the getExtendedProperties method.
Class Name |
|
|---|---|
Component |
|
Input Parameters
itemId (required)
The item ID that has markers to be removed. If omitted, the value indicated in the item input parameter is used.
item
The item that has markers to be removed. If omitted, the active item is used.
key (required)
The value in the marker’s key property. Set this parameter to ANY_VALUE to indicate that the marker’s key value is irrelevant for your purposes. For example:
<dsp:param name="key" bean="OrderHasMarkerDroplet.ANY_VALUE"/>
value
The value in the marker’s value property. You can set this parameter to NULL or omit it if the marker’s value property must be null.
Set this parameter to ANY_VALUE to indicate that the marker’s value value is irrelevant for your purposes. For example:
<dsp:param name="value" bean="OrderHasMarkerDroplet.ANY_VALUE"/>
data
The value in the marker’s data property. You can set this parameter to NULL or omit it if the marker’s data property must be null.
Set this parameter to ANY_VALUE to indicate that the marker’s data value is irrelevant for your purposes. For example:
<dsp:param name="data" bean="OrderHasMarkerDroplet.ANY_VALUE"/>
extendedProperties
A map that specifies any additional marker properties (set to the map’s key) and property values (set to the map’s value) that must exist on the marker that is retrieved.
markerManager
The marker manager component to use. If omitted, the marker manager indicated in the servlet bean’s repositoryMarkerManager property is used.
markerPropertyName
The property on the profile whose markers are to be removed. If omitted, the servlet bean uses the default value specified in its defaultMarkerPropertyName property.
markedItemType
The type of RepositoryItem that has markers to work with. If omitted, the servlet bean uses the default value specified in its defaultMarkedItemType property.
Output Parameters
markerCount
Contains the number of markers removed by this servlet bean’s execution.
errorMsg
Contains any error messages generated during the servlet bean’s execution.
Open Parameters
output
Rendered when all markers are removed from the item.
error
Rendered when an error occurred during servlet bean execution.
