public class VideoStoryboardWork extends AbstractWork
Work.Progress, Work.State
Modifier and Type | Field and Description |
---|---|
static String |
CATEGORY_VIDEO_STORYBOARD |
callerThread, completionTime, docId, docIds, FAILURE_EXCEPTION, FAILURE_MSG, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending, WORK_FAILED_EVENT, WORK_INSTANCE
Constructor and Description |
---|
VideoStoryboardWork(String repositoryName,
String docId) |
Modifier and Type | Method and Description |
---|---|
protected static String |
computeIdPrefix(String repositoryName,
String docId) |
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. |
buildWorkFailureEventProps, cleanUp, closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getOriginatingUsername, getPartitionKey, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getStatus, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, setCompletionTime, setDocument, setDocument, setDocuments, setOriginatingUsername, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString, workFailed
public static final String CATEGORY_VIDEO_STORYBOARD
public VideoStoryboardWork(String repositoryName, String docId)
protected static String computeIdPrefix(String repositoryName, String docId)
public boolean isIdempotent()
Work
Work.getId()
should always produce the same result.
The WorkManager implementation can safely skip duplicate executions of idempotent work.public String getCategory()
Work
Used to choose an execution queue.
getCategory
in interface Work
getCategory
in class AbstractWork
null
for the defaultpublic String getTitle()
Work
public void work()
Work
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 #cleanUp()
.
work
in interface Work
work
in class AbstractWork
Work.isSuspending()
,
Work.suspended()
,
Work.cleanUp(boolean, java.lang.Exception)
Copyright © 2018 Nuxeo. All rights reserved.