Package com.day.cq.wcm.command.api

Interface CopyMoveCommandBuilder

All Superinterfaces:
CommandBuilder
@ProviderType public interface CopyMoveCommandBuilder extends CommandBuilder
builder interface for the copy/move command

  • Method Details

    • withResourceResolver

      @Nonnull CopyMoveCommandBuilder withResourceResolver(@Nonnull ResourceResolver resourceResolver)
      initializes the ResourceResolver for the command builder
      Parameters:
      resourceResolver - the resource resolver for the command builder
      Returns:
      this CopyMoveCommandBuilder

    • withAssetReferenceResolver

      @Nonnull CopyMoveCommandBuilder withAssetReferenceResolver(@Nonnull AssetReferenceResolver assetRefResolver)
      sets the reference resolver to access references
      Parameters:
      assetRefResolver - the AssetReferenceResolver to get references
      Returns:
      this CopyMoveCommandBuilder

    • withContentFragmentReferenceResolver

      @Nonnull CopyMoveCommandBuilder withContentFragmentReferenceResolver(@Nonnull ContentFragmentReferenceResolver contentFragmentReferenceResolver)
      sets the content fragment reference resolver to access references
      Parameters:
      contentFragmentReferenceResolver - the ContentFragmentReferenceResolver to get references
      Returns:
      this CopyMoveCommandBuilder

    • withContentFragmentLaunchManager

      @Nonnull CopyMoveCommandBuilder withContentFragmentLaunchManager(@Nonnull ContentFragmentLaunchManager cfLaunchManager)

    • withCopy

      @Nonnull CopyMoveCommandBuilder withCopy(boolean copy)
      sets if the command is copy command or move command
      Parameters:
      copy - true if copy command, false if move command
      Returns:
      this CopyMoveCommandBuilder

    • withBeforeName

      @Nonnull CopyMoveCommandBuilder withBeforeName(@Nullable String beforeName)
      sets name of the next resource
      Parameters:
      beforeName - the name of the next resource. if null the resource is ordered at the end.
      Returns:
      this CopyMoveCommandBuilder

    • withShallow

      @Nonnull CopyMoveCommandBuilder withShallow(boolean shallow)
      sets whether to perform a shallow operation (this is currently only supported for pages)
      Parameters:
      shallow - if true only the resource content is moved.
      Returns:
      this CopyMoveCommandBuilder

    • withCheckIntegrity

      @Nonnull CopyMoveCommandBuilder withCheckIntegrity(boolean integrity)
      sets whether to do to integrity checking while performing the command
      Parameters:
      integrity - if true it is checked if the pages on the src paths can be moved to the destinations without conflicting the integrity. the integrity is conflicted if
      • the source page (or any child pages) are 'activated'
      • any reference to the page (or any child page) is 'activated'
      Returns:
      this CopyMoveCommandBuilder

    • withRetrieveAllRefs

      @Nonnull CopyMoveCommandBuilder withRetrieveAllRefs(boolean retrieveAll)
      sets whether to fetch references while performing the command
      Parameters:
      retrieveAll - if true, fetch references on server ideally when the number of items is very large.
      Returns:
      this CopyMoveCommandBuilder

    • createPathArgumentBuilder

      @Nonnull CopyMoveCommandPathArgumentBuilder createPathArgumentBuilder()
      Returns:
      a new path argument builder

    • withPathArgument

      @Nonnull CopyMoveCommandBuilder withPathArgument(@Nonnull CopyMoveCommandPathArgument pathArgument)
      append a path argument
      Parameters:
      pathArgument - the path argument instance
      Returns:
      this CopyMoveCommandBuilder

    • withTitleUpdate

      @Nonnull CopyMoveCommandBuilder withTitleUpdate(String destTitle)
      updates the title (if provided) of the moved resource
      Parameters:
      destTitle - new title of the resource at destination
      Returns:
      this CopyMoveCommandBuilder