Package org.xwiki.refactoring.job

Class AbstractDeletedDocumentsRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.job.api.AbstractCheckRightsRequest

org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request

Direct Known Subclasses:

PermanentlyDeleteRequest, RestoreRequest

public abstract class AbstractDeletedDocumentsRequest
extends AbstractCheckRightsRequest

A job request that can be used for handling deleted documents from the recycle bin.

Since:

10.10RC1

Version:

$Id: ad131a3f41c986ca361592a2b726b62d9bee31f5 $

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.xwiki.job.Request

PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractDeletedDocumentsRequest()	Default constructor.
protected	AbstractDeletedDocumentsRequest(org.xwiki.job.Request request)

Method Summary

Modifier and Type	Method	Description
String	getBatchId()
List<Long>	getDeletedDocumentIds()
org.xwiki.model.reference.WikiReference	getWikiReference()
void	setBatchId(String batchId)
void	setDeletedDocumentIds(List<Long> deletedDocumentIds)
void	setWikiReference(org.xwiki.model.reference.WikiReference wikiReference)

Methods inherited from class org.xwiki.job.api.AbstractCheckRightsRequest

getAuthorReference, getUserReference, isCheckAuthorRights, isCheckRights, setAuthorReference, setCheckAuthorRights, setCheckRights, setUserReference

Methods inherited from class org.xwiki.job.AbstractRequest

containsProperty, equals, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, hashCode, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, removeProperty, setContext, setId, setId, setId, setInteractive, setProperty, setRemote, setStatusLogIsolated, setStatusSerialized, setVerbose

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDeletedDocumentsRequest

public AbstractDeletedDocumentsRequest()

Default constructor.

AbstractDeletedDocumentsRequest

protected AbstractDeletedDocumentsRequest(org.xwiki.job.Request request)

Parameters:

request - the request to copy

Since:

14.7RC1, 14.4.4, 13.10.9

Method Detail

getBatchId

public String getBatchId()

Returns:

the ID of the batch of deleted documents to handle. If setDeletedDocumentIds(List) is also specified, the two will be merged when the operation is executed

setBatchId

public void setBatchId(String batchId)

Parameters:

batchId - the ID of the batch of deleted documents to handle. If setDeletedDocumentIds(List) is also specified, the two will be merged when the operation is executed

getDeletedDocumentIds

public List<Long> getDeletedDocumentIds()

Returns:

the list of IDs of the deleted documents to handle. If setBatchId(String) is also specified, the two will be merged when the operation is executed

setDeletedDocumentIds

public void setDeletedDocumentIds(List<Long> deletedDocumentIds)

Parameters:

deletedDocumentIds - the list of IDs of the deleted documents to handle. If setBatchId(String) is also specified, the two will be merged when the operation is executed

getWikiReference

public org.xwiki.model.reference.WikiReference getWikiReference()

Returns:

the wiki on which the handle operation is performed

setWikiReference

public void setWikiReference(org.xwiki.model.reference.WikiReference wikiReference)

Parameters:

wikiReference - the wiki on which the handle operation is performed