atg.commerce.catalog.custom
Class CatalogMigrationService

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.service.scheduler.SchedulableService
              atg.service.scheduler.SingletonSchedulableService
                  atg.commerce.catalog.CMSService
                      atg.commerce.catalog.custom.TreeWalkUpdateService
                          atg.commerce.catalog.custom.CatalogUpdateService
                              atg.commerce.catalog.custom.CatalogMigrationService

All Implemented Interfaces:

atg.commerce.catalog.CMSConstants, 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, Schedulable, java.util.EventListener

public class CatalogMigrationService
extends CatalogUpdateService

This class migrates a standard system to a custom catalog system. It creates one catalog item, and adds the categories designated as "rootCategories" to the rootCategories property of the catalog item. Then, it calls CatalogMaintenanceService to compute other necessary catalog properties.

See Also:

CatalogCompletionService

Nested Class Summary

Nested classes/interfaces inherited from class atg.commerce.catalog.custom.TreeWalkUpdateService

atg.commerce.catalog.custom.TreeWalkUpdateService.ShadowBean, atg.commerce.catalog.custom.TreeWalkUpdateService.ShadowMapKey, atg.commerce.catalog.custom.TreeWalkUpdateService.UpdateRange, atg.commerce.catalog.custom.TreeWalkUpdateService.UpdateRangeViaGSA

Nested classes/interfaces inherited from class atg.commerce.catalog.CMSService

atg.commerce.catalog.CMSService.BookkeepingForThread

Field Summary

static java.lang.String	CATEGORY_MIGRATION_ITEM_TYPE
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.commerce.catalog.custom.TreeWalkUpdateService

GENERIC_LOOP, PROCESS_NAME_PREFIX

Fields inherited from class atg.service.scheduler.SchedulableService

mJobId

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.commerce.catalog.CMSConstants

AGS_GENANCESTORS, AGS_GENANCESTORS_FOR_CATEGORY, AGS_GENANCESTORS_FOR_PRODUCT, AGS_GENCATALOGS, AGS_GENCATALOGS_FOR_CATEGORY, AGS_GENCATALOGS_FOR_PRODUCT, AGS_GENCATALOGS_FOR_SKU, AGS_GENPARENTCATS, AGS_GENPROPERTIES, AGS_GENPROPERTIES_FOR_CATEGORY, AGS_GENPROPERTIES_FOR_PRODUCT, ANCESTORS_GENERATED, CATALOGS_UPDATED, CATALOGS_VERIFIED, CATEGORIES_VERIFIED, CUS_INVALID_PARENT_BRANCH, CUS_NAME_ALREADY_IN_USE, CUS_UNABLE_TO_GET_WS, CUS_UPDATECATALOGS, CUS_USING_CHECKED_IN_WS, CUS_VM_NOT_SET, CUS_WS_NOT_CREATED, CUS_WS_NOT_CREATED_INVALID_PARENT_BRANCH, CUS_WS_REQUIRED, CVS_VERIFYCATALOGS, CVS_VERIFYCATEGORIES, CVS_VERIFYPRODUCTS, CVS_VERIFYSKUS, DEFAULT_CATALOG_FOLDER_ITEM_TYPE, DEFAULT_CATALOG_ITEM_TYPE, DEFAULT_MAP_SIZE, GENERATED_ANCESTORS_MAP, INFOS_GENERATED, IS_ANCESTORS_GENERATED_MAP, LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO, LEVEL_WARNING, MY_RESOURCE_NAME, NO_PATH, NOT_GENERATOR, sResourceBundle, TYPE_ANCESTOR, TYPE_CATALOGMAINTENANCE, TYPE_CUSTOM_MIGRATION, TYPE_MIGRATION, TYPE_UPDATE, TYPE_VERIFY, VALID_PATH

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

CatalogMigrationService()

Method Summary

java.lang.String	getCatalogDisplayName() The property catalogDisplayName
java.lang.String	getCatalogDisplayNamePropertyName() The property catalogDisplayNamePropertyName
java.lang.String	getCatalogFolderDisplayName() The property catalogFolderDisplayName
java.lang.String	getCatalogFolderDisplayNamePropertyName() The property catalogFolderDisplayNamePropertyName
CatalogMaintenanceService	getCatalogMaintenanceService() Returns property catalogMaintenanceService
CatalogProperties	getCatalogProperties() A helper class that holds commonly accessed reposority property and item names
MutableRepository	getCatalogRepository() Returns property catalogRepository
java.lang.String	getCategoryMigrationItemType() The name of the item-descriptor used for a categoryMigration item
atg.epub.PublishingWorkflowSession	getPublishingWorkflowAutomator() Gets the publishing workflow automator used to manage projects when service is run on publishing.
java.lang.String	getRootPropertyName() The Property rootPropertyName
java.lang.String	getServiceName()
javax.transaction.TransactionManager	getTransactionManager() The beginning and ending of transactions are handled by the transaction manager.
void	migrateCatalog()
boolean	performService()
void	setCatalogDisplayName(java.lang.String pCatalogDisplayName)
void	setCatalogDisplayNamePropertyName(java.lang.String pCatalogDisplayNamePropertyName)
void	setCatalogFolderDisplayName(java.lang.String pCatalogFolderDisplayName)
void	setCatalogFolderDisplayNamePropertyName(java.lang.String pCatalogFolderDisplayNamePropertyName)
void	setCatalogMaintenanceService(CatalogMaintenanceService pCatalogMaintenanceService) Sets property catalogMaintenanceService
void	setCatalogProperties(CatalogProperties pCatalogProperties)
void	setCatalogRepository(MutableRepository pCatalogRepository) Sets property catalogRepository
void	setCategoryMigrationItemType(java.lang.String pCategoryMigrationItemType)
void	setPublishingWorkflowAutomator(atg.epub.PublishingWorkflowSession pPublishingWorkflowAutomator) Sets the publishing workflow automator used to manage projects when service is run on publishing.
void	setRootPropertyName(java.lang.String pRootPropertyName)
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Methods inherited from class atg.commerce.catalog.custom.CatalogUpdateService

getNameToLog, getProjectActivityID, goingDownUpdateItem, goingUpUpdateItem, setProjectActivityID, updateCatalog, updateCatalog

Methods inherited from class atg.commerce.catalog.custom.TreeWalkUpdateService

buildParentCategoriesForCatalog, getCatalogIds, getCatalogTools, getCategoryLeafNodeArray, getCompletedItems, getDatabaseProductName, getDynamicChildrenList, getDynamicProducts, getDynamicProductsMap, getMaxItemsPerTransaction, getProcessName, getProjectWorkflow, getRangeQueryRows, getRepository, getServiceFunctions, getSizeOfBatch, isCatalogFoundInTreeStep, isComputeSubCatalogs, isIncludeDynamicChildren, performService, processTree, processTreeItems, recurseTreeAndGetCategories, setCatalogFoundInTreeStep, setCatalogIds, setCatalogTools, setCompletedItems, setComputeSubCatalogs, setDatabaseProductName, setDynamicProductsMap, setIncludeDynamicChildren, setMaxItemsPerTransaction, setProjectWorkflow, setPropertyValueAddAll, setRangeQueryRows, setRepository, setServiceFunctions, setSizeOfBatch, stringIt, stringIt, subProcessTree, treeStep, updateDynamicChildren, updateProducts, updateProductsViaBatch, updateRepository, updateRepositoryItem, updateSkus, updateSkusViaBatch

Methods inherited from class atg.commerce.catalog.CMSService

addErrorMessage, addInfoMessage, addWarningMessage, clearBookkeepingForThread, clearMessages, createCMSMessage, doScheduledTask, doService, getAvailableFunctions, getBookkeepingForThread, getCurrentMessages, getErrorMessages, getFunctionsToPerformByDefault, getInfoMessages, getServiceLock, getTotalNumberOfErrorMessages, getTotalNumberOfInfoMessages, getTotalNumberOfMessages, getTotalNumberOfWarningMessages, getWarningMessages, hasFunction, isSaveMessages, logDebug, logError, logInfo, logWarning, postService, preService, removeServiceLock, setAvailableFunctions, setFunctionsToPerformByDefault, setSaveMessages

Methods inherited from class atg.service.scheduler.SingletonSchedulableService

acquireLock, getClientLockManager, getLockName, getLockTimeOut, performScheduledTask, releaseLock, setClientLockManager, setLockName, setLockTimeOut

Methods inherited from class atg.service.scheduler.SchedulableService

doStartService, doStopService, getJobDescription, getJobId, getJobName, getSchedule, getScheduler, getThreadMethod, isTransactional, setJobDescription, setJobName, setSchedule, setScheduler, setThreadMethod, setTransactional, startScheduledJob, stopScheduledJob

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logError, logError, logInfo, logInfo, logTrace, logTrace, logTrace, 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 final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

CATEGORY_MIGRATION_ITEM_TYPE

public static java.lang.String CATEGORY_MIGRATION_ITEM_TYPE

Constructor Detail

CatalogMigrationService

public CatalogMigrationService()

Method Detail

setCatalogProperties

public void setCatalogProperties(CatalogProperties pCatalogProperties)

Overrides:

setCatalogProperties in class atg.commerce.catalog.custom.TreeWalkUpdateService

getCatalogProperties

public CatalogProperties getCatalogProperties()

A helper class that holds commonly accessed reposority property and item names

Overrides:

getCatalogProperties in class atg.commerce.catalog.custom.TreeWalkUpdateService

setCatalogRepository

public void setCatalogRepository(MutableRepository pCatalogRepository)

Sets property catalogRepository

getCatalogRepository

public MutableRepository getCatalogRepository()

Returns property catalogRepository

setCatalogMaintenanceService

public void setCatalogMaintenanceService(CatalogMaintenanceService pCatalogMaintenanceService)

Sets property catalogMaintenanceService

getCatalogMaintenanceService

public CatalogMaintenanceService getCatalogMaintenanceService()

Returns property catalogMaintenanceService

setCatalogDisplayName

public void setCatalogDisplayName(java.lang.String pCatalogDisplayName)

getCatalogDisplayName

public java.lang.String getCatalogDisplayName()

The property catalogDisplayName

setCatalogDisplayNamePropertyName

public void setCatalogDisplayNamePropertyName(java.lang.String pCatalogDisplayNamePropertyName)

getCatalogDisplayNamePropertyName

public java.lang.String getCatalogDisplayNamePropertyName()

The property catalogDisplayNamePropertyName

setCatalogFolderDisplayName

public void setCatalogFolderDisplayName(java.lang.String pCatalogFolderDisplayName)

getCatalogFolderDisplayName

public java.lang.String getCatalogFolderDisplayName()

The property catalogFolderDisplayName

setCatalogFolderDisplayNamePropertyName

public void setCatalogFolderDisplayNamePropertyName(java.lang.String pCatalogFolderDisplayNamePropertyName)

getCatalogFolderDisplayNamePropertyName

public java.lang.String getCatalogFolderDisplayNamePropertyName()

The property catalogFolderDisplayNamePropertyName

setCategoryMigrationItemType

public void setCategoryMigrationItemType(java.lang.String pCategoryMigrationItemType)

getCategoryMigrationItemType

public java.lang.String getCategoryMigrationItemType()

The name of the item-descriptor used for a categoryMigration item

setRootPropertyName

public void setRootPropertyName(java.lang.String pRootPropertyName)

getRootPropertyName

public java.lang.String getRootPropertyName()

The Property rootPropertyName

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Overrides:

setTransactionManager in class atg.commerce.catalog.CMSService

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

The beginning and ending of transactions are handled by the transaction manager.

Overrides:

getTransactionManager in class atg.commerce.catalog.CMSService

getPublishingWorkflowAutomator

public atg.epub.PublishingWorkflowSession getPublishingWorkflowAutomator()

Gets the publishing workflow automator used to manage projects when service is run on publishing.

Overrides:

getPublishingWorkflowAutomator in class CatalogUpdateService

Returns:

The PublishingWorkflowAutomator for this service.

setPublishingWorkflowAutomator

public void setPublishingWorkflowAutomator(atg.epub.PublishingWorkflowSession pPublishingWorkflowAutomator)

Sets the publishing workflow automator used to manage projects when service is run on publishing.

Overrides:

setPublishingWorkflowAutomator in class CatalogUpdateService

Parameters:

pPublishingWorkflowAutomator - The PublishingWorkflowAutomator for this service.

getServiceName

public java.lang.String getServiceName()

Overrides:

getServiceName in class CatalogUpdateService

performService

public boolean performService()

Overrides:

performService in class atg.commerce.catalog.CMSService

migrateCatalog

public void migrateCatalog()