atg.markers.userprofiling
Class ProfileMarkerServices

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.markers.userprofiling.ProfileMarkerServices

All Implemented Interfaces:

MarkerConstants, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class ProfileMarkerServices
extends GenericService
implements MarkerConstants

ProfileMarkerServices contains the methods that can be used to implement marker WebServices for profiles.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected GetService	mGetService
protected java.lang.String	mMarkerMappingFileName
protected RepositoryMarkerManager	mRepositoryMarkerManager

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

ProfileMarkerServices()

Method Summary

boolean	addMarkerToProfile(java.lang.String pProfileId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData, java.lang.String pDuplicationMode) Adds a marker to a profile.
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
RepositoryMarkerManager	getRepositoryMarkerManager() The RepositoryMarkerManager class that is used to manage repository markers.
boolean	hasLastMarker(java.lang.String pProfileId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This checks the profiles's last marker for a a matching key, value, data and extendedProperties.
boolean	hasLastMarkerWithKey(java.lang.String pProfileId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This method checks the profile's last marker with a given key for a matching value, data and extendedProperties.
boolean	hasMarker(java.lang.String pProfileId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData)
int	removeAllMarkersFromProfile(java.lang.String pProfileId) Removes all markers from the profile.
int	removeMarkersFromProfile(java.lang.String pProfileId, java.lang.String pKey, java.lang.String pValue, java.lang.String pData) This method removes the markers from the profile that match the values provided.
void	setGetService(GetService pGetService)
void	setMarkerMappingFileName(java.lang.String pMarkerMappingFileName)
void	setRepositoryMarkerManager(RepositoryMarkerManager pRepositoryMarkerManager)

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mRepositoryMarkerManager

protected RepositoryMarkerManager mRepositoryMarkerManager

mGetService

protected GetService mGetService

mMarkerMappingFileName

protected java.lang.String mMarkerMappingFileName

Constructor Detail

ProfileMarkerServices

public ProfileMarkerServices()

Method Detail

setRepositoryMarkerManager

public void setRepositoryMarkerManager(RepositoryMarkerManager pRepositoryMarkerManager)

getRepositoryMarkerManager

public RepositoryMarkerManager getRepositoryMarkerManager()

The RepositoryMarkerManager class that is used to manage repository markers.

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

addMarkerToProfile

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

Adds a marker to a profile.

Throws:

InvalidMarkerException

MarkerException

See Also:

RepositoryMarkerManager.addMarkerToItem(atg.repository.MutableRepositoryItem, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map, java.lang.String)

hasMarker

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

Throws:

MarkerException

hasLastMarker

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

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

Throws:

MarkerException

See Also:

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

hasLastMarkerWithKey

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

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

Throws:

MarkerException

See Also:

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

removeMarkersFromProfile

public int removeMarkersFromProfile(java.lang.String pProfileId,
                                    java.lang.String pKey,
                                    java.lang.String pValue,
                                    java.lang.String pData)
                             throws MarkerException

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

Throws:

MarkerException

See Also:

RepositoryMarkerManager.removeMarkersFromItem(atg.repository.MutableRepositoryItem, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

removeAllMarkersFromProfile

public int removeAllMarkersFromProfile(java.lang.String pProfileId)
                                throws MarkerException

Removes all markers from the profile.

Throws:

MarkerException

See Also:

RepositoryMarkerManager.removeAllMarkersFromItem(atg.repository.MutableRepositoryItem, java.lang.String)