atg.projects.store.util

Class DocumentLinksService

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.projects.store.util.DocumentLinksService

All Implemented Interfaces:

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

public class DocumentLinksService
extends atg.nucleus.GenericService

This class contains different methods that are user in DocumentLinksDroplet

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/11.3/EStore/src/atg/projects/store/util/DocumentLinksService.java#1 $$Change: 1385662 $

Author:

ATG

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALTERNATE
static java.lang.String	CANONICAL
static java.lang.String	CHAPTER
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	HOME
static java.lang.String	NEXT
static java.lang.String	PREV
static java.lang.String	SECTION
static java.lang.String	UP

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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
DocumentLinksService()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Locale>	getAlternateLink(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.RequestLocale pRequestLocale) Gets an available Locale that isn't the same as the current Locale and associates it with the 'alternate' canonical link reference.
java.util.Map	getBreadcrumbsLinks(atg.repository.RepositoryItem pCurrentCategory, atg.repository.RepositoryItem pCurrentProduct, atg.commerce.catalog.CatalogNavHistory pCatalogNavHistory) Get objects for home, up, chapter and section links from navigation history
java.util.Map	getOtherLinks(atg.repository.RepositoryItem pCurrentCategory, atg.repository.RepositoryItem pCurrentProduct, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.RequestLocale pRequestLocale, atg.service.collections.validator.CollectionObjectValidator[] validators) Gets objects for canonical, alternate, prev and next objects
java.util.List	getProductsList(atg.repository.RepositoryItem pCategory) Return join of childProducts property and relatedProducts property for pCategory
boolean	isInternational()
void	setInternational(boolean pInternational)

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

Class version string

See Also:

Constant Field Values

HOME

public static final java.lang.String HOME

See Also:

Constant Field Values

UP

public static final java.lang.String UP

See Also:

Constant Field Values

CHAPTER

public static final java.lang.String CHAPTER

See Also:

Constant Field Values

SECTION

public static final java.lang.String SECTION

See Also:

Constant Field Values

PREV

public static final java.lang.String PREV

See Also:

Constant Field Values

NEXT

public static final java.lang.String NEXT

See Also:

Constant Field Values

ALTERNATE

public static final java.lang.String ALTERNATE

See Also:

Constant Field Values

CANONICAL

public static final java.lang.String CANONICAL

See Also:

Constant Field Values

Constructor Detail

DocumentLinksService

public DocumentLinksService()

Method Detail

isInternational

public boolean isInternational()

Returns:

Returns true if the International module is running

setInternational

public void setInternational(boolean pInternational)

Parameters:

pInternational - Set the value for international. This should be true in the International module layer to indicate its running.

getProductsList

public java.util.List getProductsList(atg.repository.RepositoryItem pCategory)

Return join of childProducts property and relatedProducts property for pCategory

Parameters:

pCategory - the category

Returns:

join of childProducts property and relatedProducts property

getAlternateLink

public java.util.Map<java.lang.String,java.util.Locale> getAlternateLink(atg.servlet.DynamoHttpServletRequest pRequest,
                                                                         atg.servlet.RequestLocale pRequestLocale)

Gets an available Locale that isn't the same as the current Locale and associates it with the 'alternate' canonical link reference.

For example, if the current locale is 'en_US' but the current site also defines the Spanish language; Spanish will be used as the alternate canonical link and the following will be returned in a Map:

• key: "alternate", value: "es_US"

Parameters:

pRequest - The HTTP request.

pRequestLocale - The Locale for the request.

Returns:

An available 'alternate' canonical link, otherwise null.

getOtherLinks

public java.util.Map getOtherLinks(atg.repository.RepositoryItem pCurrentCategory,
                                   atg.repository.RepositoryItem pCurrentProduct,
                                   atg.servlet.DynamoHttpServletRequest pRequest,
                                   atg.servlet.RequestLocale pRequestLocale,
                                   atg.service.collections.validator.CollectionObjectValidator[] validators)

Gets objects for canonical, alternate, prev and next objects

Parameters:

pCurrentCategory - the current category

pCurrentProduct - the current product

pRequest - the request

pRequestLocale -

validators - validator to valid product and categories start\end dates

Returns:

the map of link rel attribute as key and object to generate canonical link as value

getBreadcrumbsLinks

public java.util.Map getBreadcrumbsLinks(atg.repository.RepositoryItem pCurrentCategory,
                                         atg.repository.RepositoryItem pCurrentProduct,
                                         atg.commerce.catalog.CatalogNavHistory pCatalogNavHistory)

Get objects for home, up, chapter and section links from navigation history

Parameters:

pCurrentCategory - the current category

pCurrentProduct - the current product

pCatalogNavHistory -

Returns:

the map of link rel attribute as key and object to generate canonical link as value