Package org.nuxeo.ecm.collections.core.worker

Class RemovedAbstractWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.collections.core.worker.RemovedAbstractWork

All Implemented Interfaces:

Serializable, Work

Direct Known Subclasses:

RemovedCollectionMemberWork, RemovedCollectionWork

public abstract class RemovedAbstractWork
extends AbstractWork

Since:

5.9.3

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
protected long	offset

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

Modifier	Constructor	Description
	RemovedAbstractWork()
protected	RemovedAbstractWork(long offset)

Method Summary

Modifier and Type	Method	Description
String	getId()	The work id.
protected abstract String	getQuery()
boolean	isIdempotent()	Returns true if a work with a given Work.getId() should always produce the same result.
protected abstract void	updateDocument(DocumentModel d)
void	work()	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, getCategory, getCompletionTime, getDocument, getDocuments, getOriginatingUsername, getPartitionKey, getProgress, getRetryCount, 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

getTitle, isCoalescing, isGroupJoin, onGroupJoinCompletion

Field Details

offset

protected long offset

Constructor Details

RemovedAbstractWork

public RemovedAbstractWork()

RemovedAbstractWork

protected RemovedAbstractWork(long offset)

Method Details

getQuery

protected abstract String getQuery()

getId

public String getId()

Description copied from interface: Work

The work id.

The id is used for equality comparisons, and as a key in persistent queues.

Specified by:

getId in interface Work

Overrides:

getId in class AbstractWork

Returns:

the work id, which must not be null

isIdempotent

public boolean isIdempotent()

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.

work

public void work()

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)

updateDocument

protected abstract void updateDocument(DocumentModel d)