Package org.nuxeo.ecm.platform.picture

Class PictureViewsGenerationWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.platform.picture.PictureViewsGenerationWork

All Implemented Interfaces:

Serializable, Work

@Deprecated(since="11.1")
public class PictureViewsGenerationWork
extends AbstractWork

Deprecated.

since 11.1 use RecomputeViewsAction instead

Work generating the different picture views for a Picture.

Since:

5.7

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.work.api.Work

Work.Progress, Work.State

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CATEGORY_PICTURE_GENERATION	Deprecated.
static final String	PICTURE_VIEWS_GENERATION_DONE_EVENT	Deprecated.
protected final String	xpath	Deprecated.

Fields inherited from class org.nuxeo.ecm.core.work.AbstractWork

callerThread, completionTime, docId, docIds, FAILURE_EXCEPTION, FAILURE_MSG, GLOBAL_DLQ_COUNT_REGISTRY_NAME, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending, traceContext, WORK_FAILED_EVENT, WORK_INSTANCE

Constructor Summary

Constructors

Constructor	Description
PictureViewsGenerationWork(String repositoryName, String docId, String xpath)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	firePictureViewsGenerationDoneEvent(DocumentModel doc)	Deprecated. Fire a PICTURE_VIEWS_GENERATION_DONE_EVENT
String	getCategory()	Deprecated. Gets the category for this work.
String	getPartitionKey()	Deprecated. Returns a key that can be used by the WorkManager implementation to guarantee that works with the same partition key will be executed in the order they are submitted.
int	getRetryCount()	Deprecated. Gets the number of times that this Work instance can be retried in case of concurrent update exceptions.
String	getTitle()	Deprecated. Gets a human-readable name for this work instance.
boolean	isGroupJoin()	Deprecated. When true the Work is part of a group, Works of the group have the same Work.getPartitionKey().
boolean	isIdempotent()	Deprecated. Returns true if a work with a given Work.getId() should always produce the same result.
void	onGroupJoinCompletion()	Deprecated. Called when Work.isGroupJoin() returns true and after the last Work of the group.
void	work()	Deprecated. This method should implement the actual work done by the Work instance.

Methods inherited from class org.nuxeo.ecm.core.work.AbstractWork

appendWorkToDeadLetterQueue, buildWorkFailureEventProps, cleanUp, closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getOriginatingUsername, getProgress, getSchedulePath, getSchedulingTime, getSpanFromContext, getStartTime, getStatus, getWorkInstanceState, hashCode, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, setCompletionTime, setDocument, setDocument, setDocuments, setOriginatingUsername, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString, workFailed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.work.api.Work

isCoalescing

Field Details

CATEGORY_PICTURE_GENERATION

public static final String CATEGORY_PICTURE_GENERATION

Deprecated.

See Also:

• Constant Field Values

PICTURE_VIEWS_GENERATION_DONE_EVENT

public static final String PICTURE_VIEWS_GENERATION_DONE_EVENT

Deprecated.

See Also:

• Constant Field Values

xpath

protected final String xpath

Deprecated.

Constructor Details

PictureViewsGenerationWork

public PictureViewsGenerationWork(String repositoryName,
 String docId,
 String xpath)

Deprecated.

Method Details

getCategory

public String getCategory()

Deprecated.

Description copied from interface: Work

Gets the category for this work.

Used to choose an execution queue.

Specified by:

getCategory in interface Work

Overrides:

getCategory in class AbstractWork

Returns:

the category, or null for the default

getTitle

public String getTitle()

Deprecated.

Description copied from interface: Work

Gets a human-readable name for this work instance.

Returns:

a human-readable name

getRetryCount

public int getRetryCount()

Deprecated.

Description copied from class: AbstractWork

Gets the number of times that this Work instance can be retried in case of concurrent update exceptions.

Overrides:

getRetryCount in class AbstractWork

Returns:

0 for no retry, or more if some retries are possible

See Also:

• AbstractWork.work()

isIdempotent

public boolean isIdempotent()

Deprecated.

Description copied from interface: Work

Returns true if a work with a given Work.getId() should always produce the same result. The WorkManager implementation can safely skip duplicate executions of idempotent work.

isGroupJoin

public boolean isGroupJoin()

Deprecated.

Description copied from interface: Work

When true the Work is part of a group, Works of the group have the same Work.getPartitionKey(). When all Works of the group are done the Work.onGroupJoinCompletion() hook is called.

getPartitionKey

public String getPartitionKey()

Deprecated.

Description copied from interface: Work

Returns a key that can be used by the WorkManager implementation to guarantee that works with the same partition key will be executed in the order they are submitted.

Specified by:

getPartitionKey in interface Work

Overrides:

getPartitionKey in class AbstractWork

onGroupJoinCompletion

public void onGroupJoinCompletion()

Deprecated.

Description copied from interface: Work

Called when Work.isGroupJoin() returns true and after the last Work of the group.

work

public void work()

Deprecated.

Description copied from interface: Work

This method should implement the actual work done by the Work instance.

It should periodically update its progress through Work.setProgress(org.nuxeo.ecm.core.work.api.Work.Progress).

To allow for suspension by the WorkManager, it should periodically call Work.isSuspending(), and if true call Work.suspended() return early with saved state data.

Clean up can by implemented by Work.cleanUp(boolean, Exception).

Specified by:

work in interface Work

Specified by:

work in class AbstractWork

See Also:

• Work.isSuspending()
• Work.suspended()
• Work.cleanUp(boolean, java.lang.Exception)

firePictureViewsGenerationDoneEvent

protected void firePictureViewsGenerationDoneEvent(DocumentModel doc)

Deprecated.

Fire a PICTURE_VIEWS_GENERATION_DONE_EVENT

Since:

5.8