Index (XWiki Platform - Refactoring

A B C D E G H I L M N O P R S U V W
All Classes All Packages

A

AbstractCopyOrMoveRequest - Class in org.xwiki.refactoring.job: Represents a request used for Copy, Move or Rename (though Move).
AbstractCopyOrMoveRequest() - Constructor for class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest: Default constructor.
AbstractCopyOrMoveRequest(Request) - Constructor for class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest
AbstractDeletedDocumentsRequest - Class in org.xwiki.refactoring.job: A job request that can be used for handling deleted documents from the recycle bin.
AbstractDeletedDocumentsRequest() - Constructor for class org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest: Default constructor.
AbstractDeletedDocumentsRequest(Request) - Constructor for class org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest
AbstractNamingCriterion - Class in org.xwiki.refactoring.splitter.criterion.naming: Base class for NamingCriterion implementations.
AbstractNamingCriterion() - Constructor for class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion
AUTO_REDIRECT - Static variable in class org.xwiki.refactoring.job.DeleteRequest

B

BatchOperation<E extends Exception> - Interface in org.xwiki.refactoring.batch: Describes the work done in a batch operation, executed by a BatchOperationExecutor.
BatchOperationExecutor - Interface in org.xwiki.refactoring.batch: Executes a given operation and wraps its sub-operations as part of the same batch (by passing a batch ID to the ExecutionContext).

C

changeDocumentAuthor(DocumentReference, DocumentReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job for replacing the author and the content author of the existing wiki pages.
compareTo(EntitySelection) - Method in class org.xwiki.refactoring.job.question.EntitySelection
convertToNestedDocument(DocumentReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to convert the specified terminal document to a nested document (that can have child documents).
convertToTerminalDocument(DocumentReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to convert the specified nested document to a terminal document (that can't have child documents).
copy(Collection<EntityReference>, EntityReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to copy the specified source entities to the specified destination entity.
copy(EntityReference, EntityReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to copy the specified source entity to the specified destination entity.
copy(CopyRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to perform the given copy request.
COPY - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The role hint of the job that copies entities.
COPY_AS - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The role hint of the job that copies entities with a different name or reference.
copyAs(EntityReference, String) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to copy the specified entity with a different name.
copyAs(EntityReference, EntityReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to copy the specified entity with a different reference.
copyAs(CopyRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to perform the given copy-as request.
CopyRequest - Class in org.xwiki.refactoring.job: A job request that can be used to copy some entities to another place.
CopyRequest() - Constructor for class org.xwiki.refactoring.job.CopyRequest: Default constructor.
CopyRequest(Request) - Constructor for class org.xwiki.refactoring.job.CopyRequest
create(Collection<EntityReference>) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to create the specified entities.
create(EntityReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to create the specified entity.
create(CreateRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to perform the given create request.
CREATE - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The role hint of the job that creates entities.
createCopyAsRequest(EntityReference, String) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to copy the specified entity with a different name.
createCopyAsRequest(EntityReference, EntityReference) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to copy the specified entity with a different reference.
createCopyRequest(Collection<EntityReference>, EntityReference) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to copy the specified source entities to the specified destination entity.
createCopyRequest(EntityReference, EntityReference) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to copy the specified source entity to the specified destination entity.
createCreateRequest(Collection<EntityReference>) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to create the specified entities.
createDeleteRequest(Collection<EntityReference>) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to delete the specified entities.
createMoveRequest(Collection<EntityReference>, EntityReference) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to move the specified source entities to the specified destination entity (which becomes their new parent).
createMoveRequest(EntityReference, EntityReference) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to move the specified source entity to the specified destination entity (which becomes its new parent).
createPermanentlyDeleteRequest(String) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to permanently delete a specified batch of deleted documents from the recycle bin.
createPermanentlyDeleteRequest(List<Long>) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to permanently delete a specified list of deleted documents from the recycle bin.
createRenameRequest(EntityReference, String) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to rename the specified entity.
createRenameRequest(EntityReference, EntityReference) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to rename the entity specified by the given old reference.
createReplaceUserRequest(DocumentReference, DocumentReference) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to replace the occurrences of the old user reference with the new user reference.
CreateRequest - Class in org.xwiki.refactoring.job: A job request that can be used to create a collection of entities using a specified template.
CreateRequest() - Constructor for class org.xwiki.refactoring.job.CreateRequest: Default constructor.
CreateRequest(Request) - Constructor for class org.xwiki.refactoring.job.CreateRequest
createRestoreRequest(String) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to restore a specified batch of deleted documents from the recycle bin.
createRestoreRequest(List<Long>) - Method in interface org.xwiki.refactoring.script.RequestFactory: Creates a request to restore a specified list of deleted documents from the recycle bin.

D

delete(Collection<EntityReference>) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to delete the specified entities.
delete(EntityReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to delete the specified entity.
delete(EntityRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to perform the given delete request.
DELETE - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The role hint of the job that deletes entities.
DeleteRequest - Class in org.xwiki.refactoring.job: Job request for deleting a page.
DeleteRequest() - Constructor for class org.xwiki.refactoring.job.DeleteRequest: Default constructor.
DeleteRequest(Request) - Constructor for class org.xwiki.refactoring.job.DeleteRequest
DESELECTED - org.xwiki.refactoring.job.question.EntitySelection.State: If a user deselected it.
docBridge - Variable in class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion: DocumentAccessBridge used to lookup for existing wiki pages and avoid name clashes.
DocumentCopiedEvent - Class in org.xwiki.refactoring.event: Event fired after a document has been copied.
DocumentCopiedEvent() - Constructor for class org.xwiki.refactoring.event.DocumentCopiedEvent: Default constructor, used by listeners.
DocumentCopiedEvent(DocumentReference, DocumentReference) - Constructor for class org.xwiki.refactoring.event.DocumentCopiedEvent: Creates a new instance with the given data.
DocumentCopyingEvent - Class in org.xwiki.refactoring.event: Event fired when a document is about to be copied.
DocumentCopyingEvent() - Constructor for class org.xwiki.refactoring.event.DocumentCopyingEvent: Default constructor, used by listeners.
DocumentCopyingEvent(DocumentReference, DocumentReference) - Constructor for class org.xwiki.refactoring.event.DocumentCopyingEvent: Creates a new instance with the given data.
DocumentRenamedEvent - Class in org.xwiki.refactoring.event: Event fired after a document has been renamed.
DocumentRenamedEvent() - Constructor for class org.xwiki.refactoring.event.DocumentRenamedEvent: Default constructor, used by listeners.
DocumentRenamedEvent(DocumentReference, DocumentReference) - Constructor for class org.xwiki.refactoring.event.DocumentRenamedEvent: Creates a new instance with the given data.
DocumentRenamingEvent - Class in org.xwiki.refactoring.event: Event fired when a document is about to be renamed.
DocumentRenamingEvent() - Constructor for class org.xwiki.refactoring.event.DocumentRenamingEvent: Default constructor, used by listeners.
DocumentRenamingEvent(DocumentReference, DocumentReference) - Constructor for class org.xwiki.refactoring.event.DocumentRenamingEvent: Creates a new instance with the given data.
DocumentSplitter - Interface in org.xwiki.refactoring.splitter: Component interface for splitting a WikiDocument into multiple documents.

E

EntitiesCopiedEvent - Class in org.xwiki.refactoring.event: Event fired after multiple entities have been copied.
EntitiesCopiedEvent() - Constructor for class org.xwiki.refactoring.event.EntitiesCopiedEvent
EntitiesCopyingEvent - Class in org.xwiki.refactoring.event: Event fired when multiple entities are about to be copied.
EntitiesCopyingEvent() - Constructor for class org.xwiki.refactoring.event.EntitiesCopyingEvent
EntitiesRenamedEvent - Class in org.xwiki.refactoring.event: Event fired after multiple entities have been renamed.
EntitiesRenamedEvent() - Constructor for class org.xwiki.refactoring.event.EntitiesRenamedEvent
EntitiesRenamingEvent - Class in org.xwiki.refactoring.event: Event fired when multiple entities are about to be renamed.
EntitiesRenamingEvent() - Constructor for class org.xwiki.refactoring.event.EntitiesRenamingEvent
EntityJobStatus<T extends EntityRequest> - Class in org.xwiki.refactoring.job: Generic job status for a job that performs an EntityRequest.
EntityJobStatus(String, T, ObservationManager, LoggerManager, JobStatus) - Constructor for class org.xwiki.refactoring.job.EntityJobStatus: Creates a new instance.
EntityJobStatus(T, ObservationManager, LoggerManager, JobStatus) - Constructor for class org.xwiki.refactoring.job.EntityJobStatus: Deprecated.
since 9.2RC1, use EntityJobStatus(String, EntityRequest, ObservationManager, LoggerManager, JobStatus) instead
EntityRequest - Class in org.xwiki.refactoring.job: A generic job request that targets multiple entities.
EntityRequest() - Constructor for class org.xwiki.refactoring.job.EntityRequest: Default constructor.
EntityRequest(Request) - Constructor for class org.xwiki.refactoring.job.EntityRequest
EntitySelection - Class in org.xwiki.refactoring.job.question: Represent an entity with an information about either or not the entity is selected to perform some refactoring.
EntitySelection(EntityReference) - Constructor for class org.xwiki.refactoring.job.question.EntitySelection: Construct an EntitySelection.
EntitySelection.State - Enum in org.xwiki.refactoring.job.question: Define the inner state of the EntitySelection.
equals(Object) - Method in class org.xwiki.refactoring.job.question.EntitySelection
equals(Object) - Method in class org.xwiki.refactoring.WikiDocument
execute() - Method in interface org.xwiki.refactoring.batch.BatchOperation: Do the work.
execute(BatchOperation<E>) - Method in interface org.xwiki.refactoring.batch.BatchOperationExecutor: Executes a given operation and generates a batch ID if none is already set.
execute(BatchOperation<E>, String) - Method in interface org.xwiki.refactoring.batch.BatchOperationExecutor
exists(DocumentReference) - Method in class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion

G

getBaseDocumentReference() - Method in class org.xwiki.refactoring.splitter.criterion.naming.NamingCriterionParameters
getBasePageName() - Method in class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion
getBatchId() - Method in class org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest
getCurrentBatchId() - Method in interface org.xwiki.refactoring.batch.BatchOperationExecutor
getDeletedDocumentIds() - Method in class org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest
getDestination() - Method in class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest
getDestination() - Method in class org.xwiki.refactoring.job.OverwriteQuestion
getDocumentName(XDOM) - Method in interface org.xwiki.refactoring.splitter.criterion.naming.NamingCriterion: Deprecated.
since 14.10.2, 15.0RC1 use NamingCriterion.getDocumentReference(XDOM) instead
getDocumentReference() - Method in class org.xwiki.refactoring.WikiDocument
getDocumentReference(XDOM) - Method in class org.xwiki.refactoring.splitter.criterion.naming.HeadingNameNamingCriterion
getDocumentReference(XDOM) - Method in interface org.xwiki.refactoring.splitter.criterion.naming.NamingCriterion: Generates a suitable reference for the new document represented by 'newDoc' which is a result of the splitting operation.
getDocumentReference(XDOM) - Method in class org.xwiki.refactoring.splitter.criterion.naming.PageIndexNamingCriterion
getEntityParameters(EntityReference) - Method in class org.xwiki.refactoring.job.EntityRequest
getEntityReference() - Method in class org.xwiki.refactoring.job.question.EntitySelection
getEntityReferences() - Method in class org.xwiki.refactoring.job.EntityRequest
getFullName() - Method in class org.xwiki.refactoring.WikiDocument: Deprecated.
since 14.10.2, 15.0RC1 use WikiDocument.getDocumentReference() instead
getJobType() - Method in class org.xwiki.refactoring.job.EntityRequest: Deprecated.
since 9.2RC1, use AbstractJobStatus.getJobType() instead
getLastError() - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Get the error generated while performing the previously called action.
getNewBacklinkTargets() - Method in class org.xwiki.refactoring.job.DeleteRequest
getNewUserReference() - Method in class org.xwiki.refactoring.job.ReplaceUserRequest
getOldUserReference() - Method in class org.xwiki.refactoring.job.ReplaceUserRequest
getPageName(DocumentReference) - Method in class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion
getParameter(String) - Method in class org.xwiki.refactoring.splitter.criterion.naming.NamingCriterionParameters: Get the value of a given parameter.
getParameter(String, T) - Method in class org.xwiki.refactoring.splitter.criterion.naming.NamingCriterionParameters: Get the value of a given parameter.
getParameters() - Method in class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion
getParameters() - Method in interface org.xwiki.refactoring.splitter.criterion.naming.NamingCriterion
getParent() - Method in class org.xwiki.refactoring.WikiDocument
getRequestFactory() - Method in class org.xwiki.refactoring.script.RefactoringScriptService
getSkippedEntities() - Method in class org.xwiki.refactoring.job.CreateRequest
getSource() - Method in class org.xwiki.refactoring.job.OverwriteQuestion
getState() - Method in class org.xwiki.refactoring.job.question.EntitySelection
getTemplateReference() - Method in class org.xwiki.refactoring.job.CreateRequest
getWikiReference() - Method in class org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest
getXdom() - Method in class org.xwiki.refactoring.WikiDocument
GROUP - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The name used to group the refactoring jobs.
GROUP_PREFIX - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The prefix used by all the refactoring job hits.

H

hashCode() - Method in class org.xwiki.refactoring.job.question.EntitySelection
hashCode() - Method in class org.xwiki.refactoring.WikiDocument
HeadingLevelSplittingCriterion - Class in org.xwiki.refactoring.splitter.criterion: A SplittingCriterion based on the heading levels present in an xwiki document.
HeadingLevelSplittingCriterion(int[]) - Constructor for class org.xwiki.refactoring.splitter.criterion.HeadingLevelSplittingCriterion: Constructs a new HeadingLevelSplittingCriterion.
HeadingNameNamingCriterion - Class in org.xwiki.refactoring.splitter.criterion.naming: A NamingCriterion based on the opening heading (if present) of the document.
HeadingNameNamingCriterion() - Constructor for class org.xwiki.refactoring.splitter.criterion.naming.HeadingNameNamingCriterion: Implicit constructor.
HeadingNameNamingCriterion(String, DocumentAccessBridge, BlockRenderer, boolean) - Constructor for class org.xwiki.refactoring.splitter.criterion.naming.HeadingNameNamingCriterion: Deprecated.
since 14.10.2, 15.0RC1 inject this as a component instead and set the base reference through AbstractNamingCriterion.getParameters()

I

INDEX_SEPERATOR - Static variable in interface org.xwiki.refactoring.splitter.criterion.naming.NamingCriterion: Marker used to separate page indexes.
isAskAgain() - Method in class org.xwiki.refactoring.job.OverwriteQuestion
isAutoRedirect() - Method in class org.xwiki.refactoring.job.DeleteRequest
isAutoRedirect() - Method in class org.xwiki.refactoring.job.MoveRequest
isDeep() - Method in class org.xwiki.refactoring.job.EntityRequest
isDeleteSource() - Method in class org.xwiki.refactoring.job.MoveRequest: Deprecated.
Since 10.11 the MoveRequest does not handle copy anymore. So it should always delete the source.
isOverwrite() - Method in class org.xwiki.refactoring.job.OverwriteQuestion
isRecycleBinSkippingActivated() - Method in interface org.xwiki.refactoring.RefactoringConfiguration
isRecycleBinSkippingAllowed() - Method in class org.xwiki.refactoring.script.RefactoringScriptService
isReplaceDocumentAuthor() - Method in class org.xwiki.refactoring.job.ReplaceUserRequest
isReplaceDocumentContentAuthor() - Method in class org.xwiki.refactoring.job.ReplaceUserRequest
isReplaceDocumentCreator() - Method in class org.xwiki.refactoring.job.ReplaceUserRequest
isSelected() - Method in class org.xwiki.refactoring.job.question.EntitySelection
isUpdateLinks() - Method in class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest
isUpdateLinks() - Method in class org.xwiki.refactoring.job.DeleteRequest
isUpdateLinksOnFarm() - Method in class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest: Deprecated.
not taken into account anymore
isUpdateLinksOnFarm() - Method in class org.xwiki.refactoring.job.DeleteRequest: Deprecated.
not taken into account anymore
isUpdateParentField() - Method in class org.xwiki.refactoring.job.MoveRequest
isUseTerminalPages() - Method in class org.xwiki.refactoring.splitter.criterion.naming.NamingCriterionParameters

L

logger - Variable in class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion

M

move(Collection<EntityReference>, EntityReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to move the specified source entities to the specified destination entity (which becomes their new parent).
move(EntityReference, EntityReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to move the specified source entity to the specified destination entity (which becomes its new parent).
move(MoveRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to perform the given move request.
MOVE - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The role hint for the job that moves entities.
MoveRequest - Class in org.xwiki.refactoring.job: A job request that can be used to move a collection of entities to a specified destination.
MoveRequest() - Constructor for class org.xwiki.refactoring.job.MoveRequest: Default constructor.
MoveRequest(Request) - Constructor for class org.xwiki.refactoring.job.MoveRequest

N

NamingCriterion - Interface in org.xwiki.refactoring.splitter.criterion.naming: Interface for defining various criteria for naming new documents generated while splitting.
NamingCriterionParameters - Class in org.xwiki.refactoring.splitter.criterion.naming: Parameters for NamingCriterion.
NamingCriterionParameters() - Constructor for class org.xwiki.refactoring.splitter.criterion.naming.NamingCriterionParameters
NEW_BACKLINK_TARGETS - Static variable in class org.xwiki.refactoring.job.DeleteRequest
newDocumentReference(String) - Method in class org.xwiki.refactoring.splitter.criterion.naming.AbstractNamingCriterion

O

org.xwiki.refactoring - package org.xwiki.refactoring
org.xwiki.refactoring.batch - package org.xwiki.refactoring.batch
org.xwiki.refactoring.event - package org.xwiki.refactoring.event
org.xwiki.refactoring.job - package org.xwiki.refactoring.job
org.xwiki.refactoring.job.question - package org.xwiki.refactoring.job.question
org.xwiki.refactoring.script - package org.xwiki.refactoring.script
org.xwiki.refactoring.splitter - package org.xwiki.refactoring.splitter
org.xwiki.refactoring.splitter.criterion - package org.xwiki.refactoring.splitter.criterion
org.xwiki.refactoring.splitter.criterion.naming - package org.xwiki.refactoring.splitter.criterion.naming
OverwriteQuestion - Class in org.xwiki.refactoring.job: Question asked when an entity with the same name is found during a copy or move operation and we don't know whether to overwrite or keep the existing entity.
OverwriteQuestion(EntityReference, EntityReference) - Constructor for class org.xwiki.refactoring.job.OverwriteQuestion: Ask whether to overwrite or not the destination entity with the source entity.

P

PageIndexNamingCriterion - Class in org.xwiki.refactoring.splitter.criterion.naming: A NamingCriterion based on the name of the main document being split.
PageIndexNamingCriterion() - Constructor for class org.xwiki.refactoring.splitter.criterion.naming.PageIndexNamingCriterion: Implicit constructor.
PageIndexNamingCriterion(String, DocumentAccessBridge) - Constructor for class org.xwiki.refactoring.splitter.criterion.naming.PageIndexNamingCriterion: Deprecated.
since 14.10.2, 15.0RC1 inject this as a component instead and set the base reference through AbstractNamingCriterion.getParameters()
PARAM_PREPEND_BASE_PAGE_NAME - Static variable in class org.xwiki.refactoring.splitter.criterion.naming.HeadingNameNamingCriterion
PERMANENTLY_DELETE - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The role hint of the job that permanently deletes entities.
permanentlyDelete(String) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job for permanently deleting entities.
permanentlyDelete(List<Long>) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job for permanently deleting entities.
permanentlyDelete(PermanentlyDeleteRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job for permanently deleting entities.
PermanentlyDeleteRequest - Class in org.xwiki.refactoring.job: A job request that can be used to permanently delete a list of deleted documents and/or an entire batch of deleted documents from the recycle bin.
PermanentlyDeleteRequest() - Constructor for class org.xwiki.refactoring.job.PermanentlyDeleteRequest: Default constructor.
PermanentlyDeleteRequest(Request) - Constructor for class org.xwiki.refactoring.job.PermanentlyDeleteRequest

R

RefactoringConfiguration - Interface in org.xwiki.refactoring: Provides the configurations for the refactoring module.
RefactoringException - Exception in org.xwiki.refactoring: Any exception raised in refactoring related APIs.
RefactoringException(String) - Constructor for exception org.xwiki.refactoring.RefactoringException: Constructs a new exception with the specified detail message.
RefactoringException(String, Throwable) - Constructor for exception org.xwiki.refactoring.RefactoringException: Constructs a new exception with the specified detail message and cause.
RefactoringException(Throwable) - Constructor for exception org.xwiki.refactoring.RefactoringException
RefactoringJobs - Interface in org.xwiki.refactoring.job: Known refactoring job types.
RefactoringScriptService - Class in org.xwiki.refactoring.script: Provides refactoring-specific scripting APIs.
RefactoringScriptService() - Constructor for class org.xwiki.refactoring.script.RefactoringScriptService
ReferenceRenamer - Interface in org.xwiki.refactoring: Allow to replace references during rename/move refactoring operations.
rename(EntityReference, String) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to rename the specified entity.
rename(EntityReference, EntityReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to rename the specified entity.
rename(MoveRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to perform the given rename request.
RENAME - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The role hint for the job that renames entities.
renameReferences(Block, DocumentReference, AttachmentReference, AttachmentReference, boolean) - Method in interface org.xwiki.refactoring.ReferenceRenamer: Change references of the given block so that the references pointing to the old target points to the new target.
renameReferences(Block, DocumentReference, DocumentReference, DocumentReference, boolean) - Method in interface org.xwiki.refactoring.ReferenceRenamer: Change references of the given block so that the references pointing to the old target points to the new target.
REPLACE_USER - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The role hint of the job that replace user references.
replaceUser(ReplaceUserRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job to perform the given request.
ReplaceUserRequest - Class in org.xwiki.refactoring.job: A job request that can be used to replace user references.
ReplaceUserRequest() - Constructor for class org.xwiki.refactoring.job.ReplaceUserRequest: Default constructor.
ReplaceUserRequest(Request) - Constructor for class org.xwiki.refactoring.job.ReplaceUserRequest
RequestFactory - Interface in org.xwiki.refactoring.script: Factory dedicated to the creation of the requests.
restore(String) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job for restoring the specified the batchId.
restore(List<Long>) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job for restoring the specified deleted documents.
restore(RestoreRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService: Schedules an asynchronous job for restoring the specified entities.
RESTORE - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs: The role hint of the job that deletes entities.
RestoreRequest - Class in org.xwiki.refactoring.job: A job request that can be used to restore a list of deleted documents and/or an entire batch of deleted documents from the recycle bin.
RestoreRequest() - Constructor for class org.xwiki.refactoring.job.RestoreRequest: Default constructor.
RestoreRequest(Request) - Constructor for class org.xwiki.refactoring.job.RestoreRequest

S

SELECTED - org.xwiki.refactoring.job.question.EntitySelection.State: If a user selected it.
setAskAgain(boolean) - Method in class org.xwiki.refactoring.job.OverwriteQuestion: Sets whether this question will be asked again or not if another pair of entities with the same name is found.
setAutoRedirect(boolean) - Method in class org.xwiki.refactoring.job.DeleteRequest: Sets whether the original pages should be redirected automatically to the new specified location when accessed by the user, in order to preserve external links.
setAutoRedirect(boolean) - Method in class org.xwiki.refactoring.job.MoveRequest: Sets whether the original pages should be redirected automatically to the new location when accessed by the user, in order to preserve external links.
setBaseDocumentReference(DocumentReference) - Method in class org.xwiki.refactoring.splitter.criterion.naming.NamingCriterionParameters: Set the base document reference.
setBatchId(String) - Method in class org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest
setDeep(boolean) - Method in class org.xwiki.refactoring.job.EntityRequest: Sets whether the operation should target child entities also (i.e.
setDeletedDocumentIds(List<Long>) - Method in class org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest
setDeleteSource(boolean) - Method in class org.xwiki.refactoring.job.MoveRequest: Deprecated.
Since 10.11 the MoveRequest does not handle copy anymore. So it should always delete the source.
setDestination(EntityReference) - Method in class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest: Sets the destination entity, where to move the entities specified by EntityRequest.getEntityReferences().
setEntityParameters(EntityReference, Map<String, String>) - Method in class org.xwiki.refactoring.job.EntityRequest: Associates custom parameters to a target entity.
setEntityReferences(Collection<EntityReference>) - Method in class org.xwiki.refactoring.job.EntityRequest: Sets the collection of entity references that are targeted by this request.
setJobType(String) - Method in class org.xwiki.refactoring.job.EntityRequest: Deprecated.
setNewBacklinkTargets(Map<DocumentReference, DocumentReference>) - Method in class org.xwiki.refactoring.job.DeleteRequest: Sets the new backlink target for documents after delete.
setNewUserReference(DocumentReference) - Method in class org.xwiki.refactoring.job.ReplaceUserRequest: Sets the user reference replacement.
setOldUserReference(DocumentReference) - Method in class org.xwiki.refactoring.job.ReplaceUserRequest: Sets the user reference to replace.
setOverwrite(boolean) - Method in class org.xwiki.refactoring.job.OverwriteQuestion: Sets whether to overwrite or not the destination entity with the one being copied or moved.
setParameter(String, Object) - Method in class org.xwiki.refactoring.splitter.criterion.naming.NamingCriterionParameters: Set the value of a parameter.
setReplaceDocumentAuthor(boolean) - Method in class org.xwiki.refactoring.job.ReplaceUserRequest: Sets whether to replace the author of existing pages.
setReplaceDocumentContentAuthor(boolean) - Method in class org.xwiki.refactoring.job.ReplaceUserRequest: Sets whether to replace the content author of existing pages.
setReplaceDocumentCreator(boolean) - Method in class org.xwiki.refactoring.job.ReplaceUserRequest: Sets whether to replace the creator of existing pages.
setSelected(boolean) - Method in class org.xwiki.refactoring.job.question.EntitySelection: Change the state of the entity.
setShouldSkipRecycleBin(boolean) - Method in class org.xwiki.refactoring.job.DeleteRequest: Sets whether the document should be send to the recycle bin or removed permanently.
setSkippedEntities(List<EntityReference>) - Method in class org.xwiki.refactoring.job.CreateRequest
setTemplateReference(EntityReference) - Method in class org.xwiki.refactoring.job.CreateRequest
setUpdateLinks(boolean) - Method in class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest: Sets whether the links that target the old entity reference (before the move) should be updated to target the new reference (after the move) or not.
setUpdateLinks(boolean) - Method in class org.xwiki.refactoring.job.DeleteRequest: Sets whether the links that target the old entity reference (before the delete) should be updated to point to the new specified target or not.
setUpdateLinksOnFarm(boolean) - Method in class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest: Deprecated.
not taken into account anymore
setUpdateLinksOnFarm(boolean) - Method in class org.xwiki.refactoring.job.DeleteRequest: Deprecated.
not taken into account anymore
setUpdateParentField(boolean) - Method in class org.xwiki.refactoring.job.MoveRequest: Sets whether the parent-child relationship should be preserved by updating the parent field of the source's child pages to use the destination as parent instead; false otherwise.
setUseTerminalPages(boolean) - Method in class org.xwiki.refactoring.splitter.criterion.naming.NamingCriterionParameters: Set whether to generate terminal document references for the split parts or not.
setWikiReference(WikiReference) - Method in class org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest
SHOULD_SKIP_RECYCLE_BIN - Static variable in class org.xwiki.refactoring.job.DeleteRequest: Key of the optional property that indicates whether the document should be sent to the recycle bin or removed permanently.
shouldIterate(Block, int) - Method in class org.xwiki.refactoring.splitter.criterion.HeadingLevelSplittingCriterion
shouldIterate(Block, int) - Method in interface org.xwiki.refactoring.splitter.criterion.SplittingCriterion: Limits the recursive tree traversal performed by the DocumentSplitter.
shouldSkipRecycleBin() - Method in class org.xwiki.refactoring.job.DeleteRequest
shouldSplit(Block, int) - Method in class org.xwiki.refactoring.splitter.criterion.HeadingLevelSplittingCriterion
shouldSplit(Block, int) - Method in interface org.xwiki.refactoring.splitter.criterion.SplittingCriterion: Indicates if the sub-tree rooted at the given block should be split into a separate document.
split(WikiDocument, SplittingCriterion, NamingCriterion) - Method in interface org.xwiki.refactoring.splitter.DocumentSplitter: Splits the document represented by rootDoc into multiple documents.
SplittingCriterion - Interface in org.xwiki.refactoring.splitter.criterion: An interface defining the office importer document splitting process.

U

UNKNOWN - org.xwiki.refactoring.job.question.EntitySelection.State: Default state.
UPDATE_LINKS - Static variable in class org.xwiki.refactoring.job.DeleteRequest
UPDATE_LINKS_ON_FARM - Static variable in class org.xwiki.refactoring.job.DeleteRequest: Deprecated.
not taken into account anymore

V

valueOf(String) - Static method in enum org.xwiki.refactoring.job.question.EntitySelection.State: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.refactoring.job.question.EntitySelection.State: Returns an array containing the constants of this enum type, in the order they are declared.

W

WikiDocument - Class in org.xwiki.refactoring: Represents an in-memory wiki page used by the DocumentSplitter interface.
WikiDocument(String, XDOM, WikiDocument) - Constructor for class org.xwiki.refactoring.WikiDocument: Deprecated.
since 14.10.2, 15.0RC1 use WikiDocument(DocumentReference, XDOM, WikiDocument) instead
WikiDocument(DocumentReference, XDOM, WikiDocument) - Constructor for class org.xwiki.refactoring.WikiDocument: Constructs a new WikiDocument.

A B C D E G H I L M N O P R S U V W
All Classes All Packages