atg.commerce.markers

Class OrderMarkerManager

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.markers.OrderMarkerManager

All Implemented Interfaces:

OrderMarkerConstants, OrderMergeListener, atg.core.logging.Logging, atg.core.logging.TraceLogging, MarkerValidatorContainer, 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 OrderMarkerManager
extends GenericService
implements OrderMarkerConstants, OrderMergeListener, MarkerValidatorContainer

Order based repository marker manager implementation.

Throughout the API a Commerce Order object is used as the marked item. To perform the marker operation, the OrderMarkerManager extracts the contained order repository item using the repositoryItemFromOrder method.

The caller is responsible for calling the OrderManger's updateOrder after calling an API that adds or removes marker items from the Order.

Order markers are copied when an order merge occurs in the OrderManager. However, the copy only takes place if the source order is transient.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected OrderManager	mOrderManager
protected RepositoryMarkerManager	mOrderRepositoryMarkerManager

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.commerce.markers.OrderMarkerConstants

ORDER_MARKER_RESOURCE_NAME, ORDER_PROPERTY_NAME, 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
OrderMarkerManager()

Method Summary

Modifier and Type	Method and Description
protected boolean	addMarkerItemToOrder(Order pOrder, RepositoryItem pMarkerItem, java.lang.String pMarkerPropertyName, java.lang.String pDuplicationMode) Adds a new marker item to the specified order.
RepositoryItem	addMarkerToOrder(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.util.Map pExtendedProperties) Creates a new marker item using the provided property values and adds it to the specified order.
RepositoryItem	addMarkerToOrder(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.lang.String pMarkerItemType, java.lang.String pMarkerPropertyName, java.util.Map pExtendedProperties, java.lang.String pDuplicationMode) Creates a new marker item using the provided property values and adds it to the specified order.
void	addMarkerValidator(java.lang.String pKey, MarkerValidator pMarkerValidator) Adds a marker validator.
java.lang.Object[]	createSortedArrayOfMarkers(java.util.Collection pMarkers, java.lang.String pMarkerSortPropertyName) Create a sorted array of items in ascending order using the marker sort property name provided.
int	deleteMarkers(java.lang.String pMarkedItemType, java.lang.String pMarkerItemType, java.lang.String pMarkerPropertyName, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.util.Map pExtendedProperties) Use this method to delete marker items.
void	doStartService() This method is called as service startup.
MarkerValidator	findMarkerValidator(java.lang.String pKey) Locates a marker validator component in the marker validator service map.
java.util.Collection	findMatchingMarkers(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This method returns the markers from the order that match the values provided.
java.util.Collection	findMatchingMarkers(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.lang.String pMarkerPropertyName, java.util.Map pExtendedProperties) This method returns the markers from the order that match the values provided.
java.util.Collection	findValidKeys()
java.util.List	findValidValuesForKey(java.lang.String pKey)
java.util.Collection	getAllMarkersFromOrder(Order pOrder) This method returns a copy of the current marker collection from the given Order.
java.util.Collection	getAllMarkersFromOrder(Order pOrder, java.lang.String pMarkerPropertyName) This method returns a copy of the current marker collection from the given Order.
java.lang.String[]	getMarkerPropertyNames() Returns the order property names that contain markers
OrderManager	getOrderManager() Returns the Order Manager
RepositoryMarkerManager	getOrderRepositoryMarkerManager() Returns the Repository Marker Manager for orders
java.util.Map	getValidatedKeysAndValues()
boolean	hasMarker(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This method determines if the Order contains a marker with the specified property values.
boolean	hasMarker(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.lang.String pMarkerPropertyName, java.util.Map pExtendedProperties) This method determines if the Order contains a marker with the specified property values.
boolean	isValidKey(java.lang.String pKey)
boolean	isValidValueForKey(java.lang.String pKey, java.lang.String pValue)
RepositoryItem	matchLastMarker(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This method returns the order's last marker only if it has a matching key, value and data.
RepositoryItem	matchLastMarker(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.lang.String pMarkerPropertyName, java.util.Map pExtendedProperties) This method returns the order's last marker only if it has a matching key, value, data and extendedProperties.
RepositoryItem	matchLastMarkerWithKey(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This method returns the last marker with a given key, only if it has a matching value, data and extendedProperties.
RepositoryItem	matchLastMarkerWithKey(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.lang.String pMarkerPropertyName, java.util.Map pExtendedProperties) This method returns the last marker with a given key only if it has a matching value, data and extendedProperties.
void	ordersMerged(OrderMergeEvent pEvent) When orders are merged, this method copies the markers from the source order to the destination order.
int	removeAllMarkersFromOrder(Order pOrder) Removes all markers from the order.
int	removeAllMarkersFromOrder(Order pOrder, java.lang.String pMarkerPropertyName) Removes all markers from the Order.
int	removeMarkersFromOrder(Order pOrder, 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.
int	removeMarkersFromOrder(Order pOrder, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.lang.String pMarkerPropertyName, java.util.Map pExtendedProperties) This method removes the markers from the Order that match the values provided.
void	removeMarkerValidator(java.lang.String pKey) Remove a marker validator.
protected MutableRepositoryItem	repositoryItemForOrder(Order pOrder) Gets the mutable repository item from the provided order object.
void	setMarkerPropertyNames(java.lang.String[] pMarkerPropertyNames)
void	setOrderManager(OrderManager pOrderManager) Sets the Order Manager
void	setOrderRepositoryMarkerManager(RepositoryMarkerManager pOrderRepositoryMarkerManager) Sets the Repository Marker Manager for orders

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, 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 final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

mOrderRepositoryMarkerManager

protected RepositoryMarkerManager mOrderRepositoryMarkerManager

mOrderManager

protected OrderManager mOrderManager

Constructor Detail

OrderMarkerManager

public OrderMarkerManager()

Method Detail

setOrderRepositoryMarkerManager

public void setOrderRepositoryMarkerManager(RepositoryMarkerManager pOrderRepositoryMarkerManager)

Sets the Repository Marker Manager for orders

getOrderRepositoryMarkerManager

public RepositoryMarkerManager getOrderRepositoryMarkerManager()

Returns the Repository Marker Manager for orders

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

Sets the Order Manager

getOrderManager

public OrderManager getOrderManager()

Returns the Order Manager

doStartService

public void doStartService()
                    throws ServiceException

This method is called as service startup. It verifies all the property configurations are properly set.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up

addMarkerItemToOrder

protected boolean addMarkerItemToOrder(Order pOrder,
                                       RepositoryItem pMarkerItem,
                                       java.lang.String pMarkerPropertyName,
                                       java.lang.String pDuplicationMode)
                                throws MarkerException,
                                       InvalidMarkerException

Adds a new marker item to the specified order.

Parameters:

pOrder - (required)The Order being marked.

pMarkerItem - (required)The marker item .

pDuplicationMode - Controls processing in cases where the item already contains duplicate markers.

MarkerContants.ALLOW_DUPLICATES

(default)no duplicate check.

MarkerContants.NO_DUPLICATES

If duplicates exist, don't add the new marker.

MarkerContants.REPLACE_DUPLICATES

Replace the duplicate markers with the new one.

Returns:

boolean true if the marker was added.

Throws:

MarkerException

InvalidMarkerException

See Also:

MarkerConstants.ALLOW_DUPLICATES, MarkerConstants.NO_DUPLICATES, MarkerConstants.REPLACE_DUPLICATES

addMarkerToOrder

public RepositoryItem addMarkerToOrder(Order pOrder,
                                       java.lang.String pKey,
                                       java.lang.String pValue,
                                       java.lang.String pData,
                                       java.lang.String pMarkerItemType,
                                       java.lang.String pMarkerPropertyName,
                                       java.util.Map pExtendedProperties,
                                       java.lang.String pDuplicationMode)
                                throws MarkerException,
                                       InvalidMarkerException

Creates a new marker item using the provided property values and adds it to the specified order.

Parameters:

pOrder(required)The - Order being marked.

pKey - (required)The marker item key.

pValue - The marker item value .

pData - The marker item data .

pMarkerItemType - The repository item type of the marker definition to use when creating the new marker.

pMarkerProperty - The property name containing the collection of markers on the item. Defaults to the value configured in the marker manager.

pExtendedPropertiesA - map containing the extended marker property names/values. Use this map to specify any non-default marker property values that have been added to the marker item definition.

pDuplicationMode - Controls processing in cases where the item already contains duplicate markers.

MarkerContants.ALLOW_DUPLICATES

(default)no duplicate check.

MarkerContants.NO_DUPLICATES

If duplicates exist, don't add the new marker.

MarkerContants.REPLACE_DUPLICATES

Replace the duplicate markers with the new one.

Returns:

RepositoryItem The marker repository item that was added.

Throws:

MarkerException

InvalidMarkerException

See Also:

MarkerConstants.ALLOW_DUPLICATES, MarkerConstants.NO_DUPLICATES, MarkerConstants.REPLACE_DUPLICATES

addMarkerToOrder

public RepositoryItem addMarkerToOrder(Order pOrder,
                                       java.lang.String pKey,
                                       java.lang.String pValue,
                                       java.lang.String pData,
                                       java.util.Map pExtendedProperties)
                                throws MarkerException,
                                       InvalidMarkerException

Creates a new marker item using the provided property values and adds it to the specified order.

Throws:

MarkerException

InvalidMarkerException

See Also:

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(Order pOrder,
                                  java.lang.String pKey,
                                  java.lang.String pValue,
                                  java.lang.String pData,
                                  java.lang.String pMarkerPropertyName,
                                  java.util.Map pExtendedProperties)
                           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.

If a parameter value is NULL, the marker property must be NULL to match. If the marker property value can be any value, use the constant value specified in the MarkerConstants.

Parameters:

porder - The order containing the markers.

pKey - The key value used to match markers.

pValue - The value value used to match markers.

pData - The data value used to match markers.

pMarkerPropertyName - The property on the order that contains the collection of markers.

pExtendedProperties - a map of property values used to match the marker items. If the map contains a NULL entry value, the matching marker property must also be NULL. If Map is NULL the extended properties are not included in the test.

Returns:

int total number of markers removed.

Throws:

MarkerException

See Also:

MarkerConstants.ANY_VALUE

removeMarkersFromOrder

public int removeMarkersFromOrder(Order pOrder,
                                  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:

#removeMarkerFromOrder

removeAllMarkersFromOrder

public int removeAllMarkersFromOrder(Order pOrder,
                                     java.lang.String pMarkerPropertyName)
                              throws MarkerException

Removes all markers from the Order.

Parameters:

pOrder - the order containing markers.

pMarkerPropertyName - The property on the order that contains the collection of markers.

Returns:

int total number of markers removed.

Throws:

MarkerException

removeAllMarkersFromOrder

public int removeAllMarkersFromOrder(Order pOrder)
                              throws MarkerException

Removes all markers from the order.

Throws:

MarkerException

See Also:

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

findMatchingMarkers

public java.util.Collection findMatchingMarkers(Order pOrder,
                                                java.lang.String pKey,
                                                java.lang.String pValue,
                                                java.lang.String pData,
                                                java.lang.String pMarkerPropertyName,
                                                java.util.Map pExtendedProperties)
                                         throws MarkerException

This method returns 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 included in the return collection.

Parameters:

pOrder - The order.

pKey - The key value used to match markers.

pValue - The value value used to match markers .

pData - The data value used to match markers .

pMarkerPropertyName - The property name where the markers are stored on pMarkedItem.

pExtendedProperties - A map of property values used to match the marker items. If the map contains a NULL entry value, the matching marker property must also be NULL. If Map is NULL the extended properties are not included in the test.

Returns:

Collection of matching markers.

Throws:

MarkerException

See Also:

RepositoryMarkerManager.findMatchingMarkers(atg.repository.RepositoryItem, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

findMatchingMarkers

public java.util.Collection findMatchingMarkers(Order pOrder,
                                                java.lang.String pKey,
                                                java.lang.String pValue,
                                                java.lang.String pData)
                                         throws MarkerException

This method returns 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 included in the return collection.

Throws:

MarkerException

See Also:

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

hasMarker

public boolean hasMarker(Order pOrder,
                         java.lang.String pKey,
                         java.lang.String pValue,
                         java.lang.String pData,
                         java.lang.String pMarkerPropertyName,
                         java.util.Map pExtendedProperties)
                  throws MarkerException

This method determines if the Order contains a marker with the specified property values.

Parameters:

pOrder - The order.

pKey - The key value used to match markers.

pValue - The value value used to match markers .

pData - The data value used to match markers .

pMarkerPropertyName - The property name where the markers are stored on pMarkedItem.

pExtendedProperties - a map of property values used to match the marker items. If the map contains a NULL entry value, the matching marker property must also be NULL. If Map is NULL the extended properties are not included in the test.

Returns:

boolean true if the order has a matching marker.

Throws:

MarkerException

See Also:

RepositoryMarkerManager.hasMarker(atg.repository.RepositoryItem, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

hasMarker

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

This method determines if the Order contains a marker with the specified property values.

Throws:

MarkerException

See Also:

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

matchLastMarker

public RepositoryItem matchLastMarker(Order pOrder,
                                      java.lang.String pKey,
                                      java.lang.String pValue,
                                      java.lang.String pData,
                                      java.lang.String pMarkerPropertyName,
                                      java.util.Map pExtendedProperties)
                               throws MarkerException

This method returns the order's last marker only if it has a matching key, value, data and extendedProperties.

Parameters:

pOrder - The order containing the markers.

pKey - The key value used to match markers.

pValue - The value value used to match markers.

pData - The data value used to match markers.

pMarkerPropertyName - the property containing the collection of markers.

pExtendedProperties - a map of property values used to match the marker items. If the map contains a NULL entry value, the matching marker property must also be NULL. If Map is NULL the extended properties are not included in the test.

Returns:

RepositoryItem the matching item, otherwise null.

Throws:

MarkerException

See Also:

RepositoryMarkerManager.matchLastMarker(atg.repository.RepositoryItem, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

matchLastMarker

public RepositoryItem matchLastMarker(Order pOrder,
                                      java.lang.String pKey,
                                      java.lang.String pValue,
                                      java.lang.String pData)
                               throws MarkerException

This method returns the order's last marker only if it has a matching key, value and data.

Throws:

MarkerException

See Also:

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

matchLastMarkerWithKey

public RepositoryItem matchLastMarkerWithKey(Order pOrder,
                                             java.lang.String pKey,
                                             java.lang.String pValue,
                                             java.lang.String pData,
                                             java.lang.String pMarkerPropertyName,
                                             java.util.Map pExtendedProperties)
                                      throws MarkerException

This method returns the last marker with a given key only if it has a matching value, data and extendedProperties.

Parameters:

pOrder - The order containing the markers.

pKey - (required) The key value used to match markers.

pValue - The value value used to match markers.

pData - The data value used to match markers.

pMarkerPropertyName - the property containing the collection of markers.

pExtendedProperties - a map of property values used to match the marker items. If the map contains a NULL entry value, the matching marker property must also be NULL. If Map is NULL the extended properties are not included in the test.

Returns:

RepositoryItem the matching item, otherwise null.

Throws:

MarkerException

See Also:

RepositoryMarkerManager.matchLastMarkerWithKey(atg.repository.RepositoryItem, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

matchLastMarkerWithKey

public RepositoryItem matchLastMarkerWithKey(Order pOrder,
                                             java.lang.String pKey,
                                             java.lang.String pValue,
                                             java.lang.String pData)
                                      throws MarkerException

This method returns the last marker with a given key, only if it has a matching value, data and extendedProperties.

Throws:

MarkerException

See Also:

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

getAllMarkersFromOrder

public java.util.Collection getAllMarkersFromOrder(Order pOrder,
                                                   java.lang.String pMarkerPropertyName)
                                            throws MarkerException

This method returns a copy of the current marker collection from the given Order.

Parameters:

pOrder - the order.

pMarkerPropertyName - the marker collection property name.

Returns:

Collection Collection of markers.

Throws:

MarkerException

See Also:

RepositoryMarkerManager.getAllMarkersFromItem(atg.repository.RepositoryItem, java.lang.String)

getAllMarkersFromOrder

public java.util.Collection getAllMarkersFromOrder(Order pOrder)
                                            throws MarkerException

This method returns a copy of the current marker collection from the given Order.

Throws:

MarkerException

See Also:

getAllMarkersFromOrder(atg.commerce.order.Order, java.lang.String)

repositoryItemForOrder

protected MutableRepositoryItem repositoryItemForOrder(Order pOrder)
                                                throws MarkerException

Gets the mutable repository item from the provided order object.

Override this method if you have a repository-backed order implementation this is NOT derived from OrderImpl.

Parameters:

pOrder - The Order object

Returns:

MutableRepositoryItem the mutable repository item backing the order

Throws:

MarkerException

setMarkerPropertyNames

public void setMarkerPropertyNames(java.lang.String[] pMarkerPropertyNames)

getMarkerPropertyNames

public java.lang.String[] getMarkerPropertyNames()

Returns the order property names that contain markers

ordersMerged

public void ordersMerged(OrderMergeEvent pEvent)

When orders are merged, this method copies the markers from the source order to the destination order. The source order markers are added to the destination order in the same sequence and using the same duplication mode.

The marker merge only takes place if the source order is transient.

Specified by:

ordersMerged in interface OrderMergeListener

findValidKeys

public java.util.Collection findValidKeys()

findValidValuesForKey

public java.util.List findValidValuesForKey(java.lang.String pKey)

getValidatedKeysAndValues

public java.util.Map getValidatedKeysAndValues()

Returns:

a map of valid keys mapped to their possible values

isValidKey

public boolean isValidKey(java.lang.String pKey)

Returns:

true if the key is valid

isValidValueForKey

public boolean isValidValueForKey(java.lang.String pKey,
                                  java.lang.String pValue)

Returns:

true if the value is valid for the key

createSortedArrayOfMarkers

public java.lang.Object[] createSortedArrayOfMarkers(java.util.Collection pMarkers,
                                                     java.lang.String pMarkerSortPropertyName)
                                              throws MarkerException

Create a sorted array of items in ascending order using the marker sort property name provided.

Throws:

MarkerException

See Also:

RepositoryMarkerManager.createSortedArrayOfMarkers(java.util.Collection, java.lang.String)

findMarkerValidator

public MarkerValidator findMarkerValidator(java.lang.String pKey)

Locates a marker validator component in the marker validator service map.

Specified by:

findMarkerValidator in interface MarkerValidatorContainer

Parameters:

pKey - the key used to lookup the validator.

Returns:

the MarkerValidator.

addMarkerValidator

public void addMarkerValidator(java.lang.String pKey,
                               MarkerValidator pMarkerValidator)

Adds a marker validator.

Specified by:

addMarkerValidator in interface MarkerValidatorContainer

Parameters:

pKey - the key used to identify the validator.

pMarkerValidator - the marker validator

removeMarkerValidator

public void removeMarkerValidator(java.lang.String pKey)

Remove a marker validator.

Specified by:

removeMarkerValidator in interface MarkerValidatorContainer

Parameters:

pKey - the key used to identify the validator.

deleteMarkers

public int deleteMarkers(java.lang.String pMarkedItemType,
                         java.lang.String pMarkerItemType,
                         java.lang.String pMarkerPropertyName,
                         java.lang.String pKey,
                         java.lang.String pValue,
                         java.lang.String pData,
                         java.util.Map pExtendedProperties)
                  throws MarkerException

Use this method to delete marker items. This method can be used to delete markers that are contained in a Set and is not supported for marker items that are contained in a List.

Parameters:

pMarkedItemType - the repository item type of the item that contains the Set relationship to the marker items.

pMarkerItemType - the repository item type of the marker items.

pMarkerPropertyName - the property on the pMarkedItemType that is the marker set

pKey - marker key

pValue - marker value

pData - marker data

pExtendedProperites - a map containg the property to value mappings

Returns:

total number of markers deleted

Throws:

MarkerException

See Also:

RepositoryMarkerManager.deleteMarkers(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)