public class PictureViewsGenerationWork extends AbstractWork
Work.Progress, Work.State
Modifier and Type | Field and Description |
---|---|
static String |
CATEGORY_PICTURE_GENERATION |
static String |
PICTURE_VIEWS_GENERATION_DONE_EVENT |
protected String |
xpath |
callerThread, completionTime, docId, docIds, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending
Constructor and Description |
---|
PictureViewsGenerationWork(String repositoryName,
String docId,
String xpath) |
Modifier and Type | Method and Description |
---|---|
protected void |
firePictureViewsGenerationDoneEvent(DocumentModel doc)
Fire a
PICTURE_VIEWS_GENERATION_DONE_EVENT event when no other PictureViewsGenerationWork is scheduled
for this document. |
String |
getCategory()
Gets the category for this work.
|
int |
getRetryCount()
Gets the number of times that this Work instance can be retried in case of concurrent update exceptions.
|
String |
getTitle()
Gets a human-readable name for this work instance.
|
void |
work()
This method should implement the actual work done by the
Work instance. |
cleanUp, closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getOriginatingUsername, getProgress, 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
public static final String CATEGORY_PICTURE_GENERATION
public static final String PICTURE_VIEWS_GENERATION_DONE_EVENT
public PictureViewsGenerationWork(String repositoryName, String docId, String xpath)
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 int getRetryCount()
AbstractWork
getRetryCount
in class AbstractWork
AbstractWork.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)
protected void firePictureViewsGenerationDoneEvent(DocumentModel doc)
PICTURE_VIEWS_GENERATION_DONE_EVENT
event when no other PictureViewsGenerationWork is scheduled
for this document.Copyright © 2017 Nuxeo. All rights reserved.