- 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 - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs
-
The role hint of the job that copies entities.
- copy(CopyRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService
-
Schedules an asynchronous job to perform the given copy request.
- 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_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(CopyRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService
-
Schedules an asynchronous job to perform the given copy-as request.
- 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(EntityReference, String) - Method in class org.xwiki.refactoring.script.RefactoringScriptService
-
Schedules an asynchronous job to copy the specified entity with a different name.
- 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
-
- CREATE - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs
-
The role hint of the job that creates entities.
- create(CreateRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService
-
Schedules an asynchronous job to perform the given create request.
- 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.
- createCopyAsRequest(EntityReference, EntityReference) - Method in interface org.xwiki.refactoring.script.RequestFactory
-
Creates a request to copy the specified entity with a different reference.
- createCopyAsRequest(EntityReference, String) - Method in interface org.xwiki.refactoring.script.RequestFactory
-
Creates a request to copy the specified entity with a different name.
- 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, EntityReference) - Method in interface org.xwiki.refactoring.script.RequestFactory
-
Creates a request to rename the entity specified by the given old reference.
- createRenameRequest(EntityReference, String) - Method in interface org.xwiki.refactoring.script.RequestFactory
-
Creates a request to rename the specified entity.
- 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
-
- 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.
- DELETE - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs
-
The role hint of the job that deletes entities.
- delete(EntityRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService
-
Schedules an asynchronous job to perform the given delete request.
- 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.
- 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.
- RefactoringConfiguration - Interface in org.xwiki.refactoring
-
Provides the configurations for the refactoring module.
- 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 - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs
-
The role hint for the job that renames entities.
- rename(MoveRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService
-
Schedules an asynchronous job to perform the given rename request.
- rename(EntityReference, EntityReference) - Method in class org.xwiki.refactoring.script.RefactoringScriptService
-
Schedules an asynchronous job to rename the specified entity.
- rename(EntityReference, String) - Method in class org.xwiki.refactoring.script.RefactoringScriptService
-
Schedules an asynchronous job to rename the specified entity.
- 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
-
- RequestFactory - Interface in org.xwiki.refactoring.script
-
Factory dedicated to the creation of the requests.
- RESTORE - Static variable in interface org.xwiki.refactoring.job.RefactoringJobs
-
The role hint of the job that deletes entities.
- restore(RestoreRequest) - Method in class org.xwiki.refactoring.script.RefactoringScriptService
-
Schedules an asynchronous job for restoring the specified entities.
- 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.
- 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
-
- 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.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.
- 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
-
- setDestination(EntityReference) - Method in class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest
-
- 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.
- 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.
- 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.
- 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.
- setUpdateLinksOnFarm(boolean) - Method in class org.xwiki.refactoring.job.AbstractCopyOrMoveRequest
-
Sets whether the job should update the links that target the old entity reference (before the move) from anywhere
on the farm, or only from the wiki where the entity was located before the mode.
- 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.
- setWikiReference(WikiReference) - Method in class org.xwiki.refactoring.job.AbstractDeletedDocumentsRequest
-
- shouldIterate(Block, int) - Method in class org.xwiki.refactoring.splitter.criterion.HeadingLevelSplittingCriterion
-
- shouldIterate(Block, int) - Method in interface org.xwiki.refactoring.splitter.criterion.SplittingCriterion
-
- 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.