Communicates with the marker manager to create a marker and attach it to the appropriate order, based on the marker and order information you specify.
Class Name |
|
Component |
|
Input Parameters
key (required)
The value to save to the marker’s key
property. The key
property holds a string that represents a similarity among a grouping of markers. For example, key
can represent a type of marker or the circumstances under which the marker is assigned.
order
The order to which the marker is assigned. If omitted, the active order is used.
value
The value that is saved to the marker’s value
property. The value
property holds a string that is related to the key
property.
data
The value that is saved to the marker’s data
property. The data
property holds a string that is related to the key
and value
properties.
extendedProperties
A map that specifies any property values for marker properties (other than key, value, and data) that are saved to the new marker.
duplicationMode
The duplication policy used by the marker manager. Options include ALLOW_DUPLICATES
, REPLACE_DUPLICATES
, and NO_DUPLICATES
. If an order has a marker and a marker manager attempts to add an identical marker to it, a mode of REPLACE_DUPLACES
causes the existing marker to be replaced by the new one, while a mode of NO_DUPLICATES
keeps the existing marker and discards the new one. If this parameter is omitted, the servlet bean uses the default mode provided in its defaultDuplicationMode
property.
markerPropertyName
The property on the order that stores the markers created by this servlet bean. If omitted, the servlet bean uses the default specified in its defaultMarkerPropertyName
property.
markerItemType
The type of RepositoryItem
used by the marker. If omitted, the servlet bean uses the default specified in its defaultMarkerItemType
property.
markedItemType
The type of RepositoryItem
that receives a marker. If omitted, the servlet bean uses the default specified in its defaultMarkedItemType
property.
Output Parameters
marker
Contains the order marker created by the servlet bean.
errorMsg
Contains any error messages generated during the servlet bean’s execution.
Open Parameters
output
Rendered when the marker is added to the order.
error
Rendered when a marker should be created and attached to a order, but one or both actions are not completed successfully.