atg.markers.droplet
Class RemoveMarkersFromItem
java.lang.Object
atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.nucleus.TimedOperationService
atg.nucleus.servlet.ServletService
atg.nucleus.servlet.HttpServletService
atg.servlet.DynamoServlet
atg.markers.droplet.MarkerDroplet
atg.markers.droplet.RemoveMarkersFromItem
- All Implemented Interfaces:
- MarkerConstants, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet
- Direct Known Subclasses:
- RemoveMarkersFromProfile
public class RemoveMarkersFromItem
- extends MarkerDroplet
This implementation of a marker droplet will remove marker items from
a repository item.
Markers are identifed 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 param or by
extending the getExtendedProperties method.
input params
- item or itemId
- (required)Either the repository item or the repository item id to
be used in the marker operation.
- key
- (optional)the marker's key
- value
- (optional)the marker's value
- data
- (optional)the marker's data
- extendedProperties
- (optional)the extended properties map
- markerManager
- (optional)the marker manager to use. Specifying this value
overrides the default value configured in the droplet.
- markerPropertyName
- (optional) the property name on the item that contains
the collection of markers. Specifying this value overrides the default
value configured in the Droplet.
- markedItemType
- (optional)the item type of the marked item. Used in conjunction
with itemId.
Specifying this value overrides the default value
configured in the droplet.
output parameters
- markerCount
- the number of markers reemoved
- errorMsg
- the error message describing a failure.
oparams
- output
- rendered on successful completion.
- error
- rendered on error.
Field Summary |
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.markers.droplet.MarkerDroplet |
DATA_PARAM, DUPLICATION_MODE_PARAM, EMPTY_OPARAM, ERROR_MSG_PARAM, ERROR_OPARAM, FALSE_OPARAM, ITEM_ID_PARAM, ITEM_PARAM, KEY_PARAM, MARKED_ITEM_TYPE_PARAM, MARKER_COUNT, MARKER_ELEMENT, MARKER_EXTPROPS_PARAM, MARKER_ITEM_TYPE_PARAM, MARKER_MANAGER_PARAM, MARKER_PROPERTY_NAME_PARAM, MARKERS_ELEMENT, mRepositoryMarkerManager, mTransactionManager, OUTPUT_OPARAM, TRUE_OPARAM, VALUE_PARAM |
Fields inherited from interface atg.markers.MarkerConstants |
ALLOW_DUPLICATES, ANY_VALUE, DEFAULT_MARKER_ID_PROPERTY_NAME, DEFAULT_MARKER_ITEM_TYPE, DEFAULT_MARKER_PROPERTY_NAME, DEFAULT_MARKER_SORT_PROPERTY_NAME, MARKER_CREATIONDATE_PROPERTY_NAME, MARKER_DATA_PROPERTY_NAME, MARKER_DUPLICATIONMODE_PROPERTY_NAME, MARKER_KEY_PROPERTY_NAME, MARKER_OWNER_PROPERTY_NAME, MARKER_RESOURCE_NAME, MARKER_VALUE_PROPERTY_NAME, NO_DUPLICATES, PARAM_DATA, PARAM_DUPMODE, PARAM_EXTENDED_PROPERTIES, PARAM_ITEM, PARAM_ITEM_ID, PARAM_KEY, PARAM_MARKED_ITEM_TYPE, PARAM_MARKER_ITEM_TYPE, PARAM_MARKER_MANAGER, PARAM_MARKER_PROPERTY_NAME, PARAM_VALUE, REPLACE_DUPLICATES, sResourceBundle |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
DEFAULT_LOG_TRACE_STATUS |
Methods inherited from class atg.markers.droplet.MarkerDroplet |
getANY_VALUE, getData, getDefaultDuplicationMode, getDefaultMarkedItemType, getDefaultMarkerItemType, getDefaultMarkerPropertyName, getDuplicationMode, getExtendedProperties, getItem, getItemId, getKey, getMarkedItemType, getMarkerItemType, getMarkerManager, getMarkerPropertyName, getRepositoryMarkerManager, getTransactionManager, getValue, service, setDefaultDuplicationMode, setDefaultMarkedItemType, setDefaultMarkerItemType, setDefaultMarkerPropertyName, setRepositoryMarkerManager, setTransactionManager, validateInput |
Methods inherited from class atg.nucleus.GenericService |
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CLASS_VERSION
public static java.lang.String CLASS_VERSION
- Class version string
RemoveMarkersFromItem
public RemoveMarkersFromItem()
doService
public java.lang.String doService(DynamoHttpServletRequest req,
DynamoHttpServletResponse res)
throws MarkerException,
javax.servlet.ServletException,
java.io.IOException
- This method removes markers from the item provided.
Sets the following output parameters on success.
- Specified by:
doService
in class MarkerDroplet
- Returns:
- String the oparam to render after successful return
- Throws:
MarkerException
javax.servlet.ServletException
java.io.IOException
- See Also:
MarkerDroplet.MARKER_COUNT
,
MarkerDroplet.OUTPUT_OPARAM