atg.markers.droplet

Class AddMarkerToItem

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.AddMarkerToItem

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, MarkerConstants, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, java.util.EventListener, javax.servlet.Servlet

Direct Known Subclasses:

AddMarkerToProfile

public class AddMarkerToItem
extends MarkerDroplet

This implementation of a marker droplet will add a marker item to a repository item.

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

(required)the marker's key

value

(optional)the marker's value

data

(optional)the marker's data

extendedProperties

(optional)the extended properties map

duplicationMode

(optional)marker manager mode of handling duplicate markers. Specifying this value overrides the default value configured in the droplet

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.

markerItemType

(optional) the marker item type. Specifying this value overrides the default value configured in the droplet.

markedItemType

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

marker

the marker item that was created.

errorMsg

the error message describing a failure.

oparams

output

rendered on successful completion.

error

rendered on error.

Field Summary

Fields

Modifier and Type	Field and Description
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 class atg.servlet.DynamoServlet

mAllowCleanupRequest, mParameters

Fields inherited from class atg.nucleus.servlet.ServletService

SERVLET_INFO_KEY

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
AddMarkerToItem()

Method Summary

Modifier and Type	Method and Description
java.lang.String	doService(DynamoHttpServletRequest req, DynamoHttpServletResponse res) This method adds a new marker to the item provided.

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.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, 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, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

AddMarkerToItem

public AddMarkerToItem()

Method Detail

doService

public java.lang.String doService(DynamoHttpServletRequest req,
                                  DynamoHttpServletResponse res)
                           throws MarkerException,
                                  javax.servlet.ServletException,
                                  java.io.IOException

This method adds a new marker to the item provided.

Sets the output parameters on success.

Specified by:

doService in class MarkerDroplet

Returns:

String the oparam to render on success.

Throws:

MarkerException

javax.servlet.ServletException

java.io.IOException

See Also:

MarkerDroplet.MARKER_ELEMENT, MarkerDroplet.OUTPUT_OPARAM