atg.commerce.markers
Class OrderMarkerServices

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.commerce.markers.OrderMarkerServices

All Implemented Interfaces:

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, java.util.EventListener

public class OrderMarkerServices
extends GenericService
implements MarkerConstants

OrderMarkerServices contains the methods that implement Marker WebServices for Orders.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected GetService	mGetService
protected java.lang.String	mMarkerMappingFileName
protected OrderMarkerManager	mOrderMarkerManager
protected OrderServices	mOrderServices
protected javax.transaction.TransactionManager	mTransactionManager

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

OrderMarkerServices()

Method Summary

boolean	addMarkerToOrder(java.lang.String pOrderId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.lang.String pDuplicationMode) Adds a marker to an order
GetService	getGetService() The tool used to convert orders to xml in getOrderAsXML
protected java.lang.String	getMarkerMappingFileName() The name of the mapping file used when converting markers to xml
OrderMarkerManager	getOrderMarkerManager() The OrderMarkerManager class that is used to manage orders.
OrderServices	getOrderServices() The OrderServices class that is used to manage order markers.
javax.transaction.TransactionManager	getTransactionManager() Transaction Manager
boolean	hasLastMarker(java.lang.String pOrderId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This checks the order's last marker for a a matching key, value and data.
boolean	hasLastMarkerWithKey(java.lang.String pOrderId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This method checks the orders's last marker with a given key for a matching value, and data.
boolean	hasMarker(java.lang.String pOrderId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData)
int	removeAllMarkersFromOrder(java.lang.String pOrderId) Removes all markers from the order.
int	removeMarkersFromOrder(java.lang.String pOrderId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This method removes the markers from the order that match the values provided.
void	setGetService(GetService pGetService)
void	setMarkerMappingFileName(java.lang.String pMarkerMappingFileName)
void	setOrderMarkerManager(OrderMarkerManager pOrderMarkerManager)
void	setOrderServices(OrderServices pOrderServices)
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager) Sets the Transaction Manager.

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

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, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mOrderMarkerManager

protected OrderMarkerManager mOrderMarkerManager

mOrderServices

protected OrderServices mOrderServices

mTransactionManager

protected javax.transaction.TransactionManager mTransactionManager

mGetService

protected GetService mGetService

mMarkerMappingFileName

protected java.lang.String mMarkerMappingFileName

Constructor Detail

OrderMarkerServices

public OrderMarkerServices()

Method Detail

setOrderMarkerManager

public void setOrderMarkerManager(OrderMarkerManager pOrderMarkerManager)

getOrderMarkerManager

public OrderMarkerManager getOrderMarkerManager()

The OrderMarkerManager class that is used to manage orders.

setOrderServices

public void setOrderServices(OrderServices pOrderServices)

getOrderServices

public OrderServices getOrderServices()

The OrderServices class that is used to manage order markers.

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Sets the Transaction Manager.

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Transaction Manager

setGetService

public void setGetService(GetService pGetService)

getGetService

public GetService getGetService()

The tool used to convert orders to xml in getOrderAsXML

setMarkerMappingFileName

public void setMarkerMappingFileName(java.lang.String pMarkerMappingFileName)

getMarkerMappingFileName

protected java.lang.String getMarkerMappingFileName()

The name of the mapping file used when converting markers to xml

addMarkerToOrder

public boolean addMarkerToOrder(java.lang.String pOrderId,
                                java.lang.String pKey,
                                java.lang.String pValue,
                                java.lang.String pData,
                                java.lang.String pDuplicationMode)
                         throws InvalidMarkerException,
                                MarkerException

Adds a marker to an order

Throws:

InvalidMarkerException

MarkerException

See Also:

OrderMarkerManager.addMarkerToOrder(atg.commerce.order.Order, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map, java.lang.String)

removeMarkersFromOrder

public int removeMarkersFromOrder(java.lang.String pOrderId,
                                  java.lang.String pKey,
                                  java.lang.String pValue,
                                  java.lang.String pData)
                           throws MarkerException

This method removes the markers from the order that match the values provided. Each marker in the order's collection is compared to each of the property values provided. If all the properties match, the marker is removed.

Throws:

MarkerException

See Also:

OrderMarkerManager.removeMarkersFromOrder(atg.commerce.order.Order, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

removeAllMarkersFromOrder

public int removeAllMarkersFromOrder(java.lang.String pOrderId)
                              throws MarkerException

Removes all markers from the order.

Throws:

MarkerException

See Also:

OrderMarkerManager.removeAllMarkersFromOrder(atg.commerce.order.Order, java.lang.String)

hasMarker

public boolean hasMarker(java.lang.String pOrderId,
                         java.lang.String pKey,
                         java.lang.String pValue,
                         java.lang.String pData)
                  throws MarkerException

Throws:

MarkerException

hasLastMarker

public boolean hasLastMarker(java.lang.String pOrderId,
                             java.lang.String pKey,
                             java.lang.String pValue,
                             java.lang.String pData)
                      throws MarkerException

This checks the order's last marker for a a matching key, value and data.

Throws:

MarkerException

See Also:

OrderMarkerManager.matchLastMarker(atg.commerce.order.Order, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

hasLastMarkerWithKey

public boolean hasLastMarkerWithKey(java.lang.String pOrderId,
                                    java.lang.String pKey,
                                    java.lang.String pValue,
                                    java.lang.String pData)
                             throws MarkerException

This method checks the orders's last marker with a given key for a matching value, and data.

Throws:

MarkerException

See Also:

OrderMarkerManager.matchLastMarkerWithKey(atg.commerce.order.Order, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)