Package org.xwiki.refactoring.job

Class ReplaceUserRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.job.api.AbstractCheckRightsRequest

org.xwiki.refactoring.job.EntityRequest

org.xwiki.refactoring.job.ReplaceUserRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request

public class ReplaceUserRequest
extends EntityRequest

A job request that can be used to replace user references.

Since:

11.8RC1

Version:

$Id: de18e8a95f349ebc5732825fccb20a4ebd6f1d26 $

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.xwiki.job.Request

PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor	Description
ReplaceUserRequest()	Default constructor.
ReplaceUserRequest(org.xwiki.job.Request request)

Method Summary

Modifier and Type	Method	Description
org.xwiki.model.reference.DocumentReference	getNewUserReference()
org.xwiki.model.reference.DocumentReference	getOldUserReference()
boolean	isReplaceDocumentAuthor()
boolean	isReplaceDocumentContentAuthor()
boolean	isReplaceDocumentCreator()
void	setNewUserReference(org.xwiki.model.reference.DocumentReference newUserRefernce)	Sets the user reference replacement.
void	setOldUserReference(org.xwiki.model.reference.DocumentReference oldUserReference)	Sets the user reference to replace.
void	setReplaceDocumentAuthor(boolean replace)	Sets whether to replace the author of existing pages.
void	setReplaceDocumentContentAuthor(boolean replace)	Sets whether to replace the content author of existing pages.
void	setReplaceDocumentCreator(boolean replace)	Sets whether to replace the creator of existing pages.

Methods inherited from class org.xwiki.refactoring.job.EntityRequest

getEntityParameters, getEntityReferences, getJobType, isDeep, setDeep, setEntityParameters, setEntityReferences, setJobType

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

ReplaceUserRequest

public ReplaceUserRequest()

Default constructor.

ReplaceUserRequest

public ReplaceUserRequest(org.xwiki.job.Request request)

Parameters:

request - the request to copy

Since:

14.7RC1, 14.4.4, 13.10.9

Method Detail

setOldUserReference

public void setOldUserReference(org.xwiki.model.reference.DocumentReference oldUserReference)

Sets the user reference to replace.

Parameters:

oldUserReference - the user reference to replace

getOldUserReference

public org.xwiki.model.reference.DocumentReference getOldUserReference()

Returns:

the user reference to replace

setNewUserReference

public void setNewUserReference(org.xwiki.model.reference.DocumentReference newUserRefernce)

Sets the user reference replacement.

Parameters:

newUserRefernce - the user reference replacement

getNewUserReference

public org.xwiki.model.reference.DocumentReference getNewUserReference()

Returns:

the user reference replacement

setReplaceDocumentAuthor

public void setReplaceDocumentAuthor(boolean replace)

Sets whether to replace the author of existing pages.

Parameters:

replace - true to replace the page author, false to preserve it

isReplaceDocumentAuthor

public boolean isReplaceDocumentAuthor()

Returns:

whether to replace the author of existing pages

setReplaceDocumentContentAuthor

public void setReplaceDocumentContentAuthor(boolean replace)

Sets whether to replace the content author of existing pages.

Parameters:

replace - true to replace the page content author, false to preserve it

isReplaceDocumentContentAuthor

public boolean isReplaceDocumentContentAuthor()

Returns:

whether to replace the content author of existing pages

setReplaceDocumentCreator

public void setReplaceDocumentCreator(boolean replace)

Sets whether to replace the creator of existing pages.

Parameters:

replace - true to replace the page creator, false to preserve it

isReplaceDocumentCreator

public boolean isReplaceDocumentCreator()

Returns:

whether to replace the creator of existing pages