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

Class RemoveFromCollectionWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.collections.core.worker.RemoveFromCollectionWork

All Implemented Interfaces:

Serializable, Work

public class RemoveFromCollectionWork
extends AbstractWork

Since:

7.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
static final String	CATEGORY
protected String	collectionId
protected List<String>	collectionMemberIds
protected static final String	TITLE

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
RemoveFromCollectionWork(String repoName, String collectionId, List<String> collectionMemberIds, int offset)

Method Summary

Modifier and Type	Method	Description
String	getCategory()	Gets the category for this work.
String	getTitle()	Gets a human-readable name for this work instance.
boolean	isIdempotent()	Returns true if a work with a given Work.getId() should always produce the same result.
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, getCompletionTime, getDocument, getDocuments, getId, 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

isCoalescing, isGroupJoin, onGroupJoinCompletion

Field Details

CATEGORY

public static final String CATEGORY

See Also:

• Constant Field Values

TITLE

protected static final String TITLE

See Also:

• Constant Field Values

collectionMemberIds

protected List<String> collectionMemberIds

collectionId

protected String collectionId

Constructor Details

RemoveFromCollectionWork

public RemoveFromCollectionWork(String repoName,
 String collectionId,
 List<String> collectionMemberIds,
 int offset)

Method Details

getCategory

public String getCategory()

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

Description copied from interface: Work

Gets a human-readable name for this work instance.

Returns:

a human-readable name

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)