Package org.opencms.ade.contenteditor

Class CmsContentService.ContentAugmentationJob

java.lang.Object

org.opencms.ade.contenteditor.CmsContentService.ContentAugmentationJob

Enclosing class:

CmsContentService

protected class CmsContentService.ContentAugmentationJob
extends Object

The data associated with a content augmentation job.

Constructor Summary

Constructors

Constructor	Description
ContentAugmentationJob(I_CmsXmlContentAugmentation augmentation, CmsObject cms, CmsADEConfigData config, CmsXmlContent originalCopy, Locale currentLocale, Map<String,String> params)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	abort()	Sets the state to aborted.
void	finish()	Sets the state to done.
CmsContentAugmentationDetails	getDetails()	Gets a bean containing the result or progress information for the purpose of informing the client.
CmsUUID	getId()	Gets the job id.
void	run()	Runs the actual content augmentation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ContentAugmentationJob

public ContentAugmentationJob(I_CmsXmlContentAugmentation augmentation,
 CmsObject cms,
 CmsADEConfigData config,
 CmsXmlContent originalCopy,
 Locale currentLocale,
 Map<String,String> params)

Creates a new instance.

Parameters:

augmentation - the content augmentation to use

cms - the CMS context

config - the sitemap configuration

originalCopy - the original copy of the XML content object

currentLocale - the current locale

params - other parameters necessary for the augmentation

Method Details

abort

public void abort()

Sets the state to aborted.

finish

public void finish()

Sets the state to done.

getDetails

public CmsContentAugmentationDetails getDetails()

Gets a bean containing the result or progress information for the purpose of informing the client.

Returns:

the content augmentation details

getId

public CmsUUID getId()

Gets the job id.

Returns:

the job id

run

public void run()

Runs the actual content augmentation.