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

Interface DeleteCommandBuilder

  • All Superinterfaces:
    CommandBuilder
    @ProviderType
public interface DeleteCommandBuilder
extends CommandBuilder
    builder interface for the delete command

    • Method Detail

      • withResourceResolver

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

      • withPageManager

        @Nonnull
DeleteCommandBuilder withPageManager​(@Nonnull
                                     PageManager pageManager)
        initializes the PageManager which provides methods for page level operations
        Returns:
        this DeleteCommandBuilder

      • withI18N

        @Nonnull
DeleteCommandBuilder withI18N​(@Nonnull
                              I18n i18n)
        initializes the I18n object for the command builder
        Parameters:
        i18n - the internationalization object for the command builder
        Returns:
        this DeleteCommandBuilder

      • withReplicator

        @Nonnull
DeleteCommandBuilder withReplicator​(@Nonnull
                                    Replicator replicator)
        initializes the Replicator for the command builder
        Parameters:
        replicator - the replicator for the command builder
        Returns:
        this DeleteCommandBuilder

      • withEventAdmin

        @Nonnull
DeleteCommandBuilder withEventAdmin​(@Nonnull
                                    org.osgi.service.event.EventAdmin eventAdmin)
        initializes the EventAdmin for the command builder
        Parameters:
        eventAdmin - the EventAdmin for the command builder
        Returns:
        this DeleteCommandBuilder

      • withAssetReferenceResolver

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

      • withContentFragmentReferenceResolver

        @Nonnull
DeleteCommandBuilder withContentFragmentReferenceResolver​(@Nonnull
                                                          com.adobe.cq.dam.cfm.extensions.ContentFragmentReferenceResolver contentFragmentRefResolver)
        sets the reference resolver to access references for content fragments
        Parameters:
        contentFragmentRefResolver - the ContentFragmentReferenceResolver to get references
        Returns:
        this DeleteCommandBuilder

      • withPredicateProvider

        @Nonnull
DeleteCommandBuilder withPredicateProvider​(@Nonnull
                                           PredicateProvider predicateProvider)
        initializes the PredicateProvider for the command builder
        Parameters:
        predicateProvider - the predicate provider for the command builder
        Returns:
        this DeleteCommandBuilder

      • withDeleteWhitelistRootPaths

        @Nonnull
DeleteCommandBuilder withDeleteWhitelistRootPaths​(@Nonnull
                                                  java.lang.String[] deleteWhitelistRootPaths)
        set whitelist of root paths where deletion is allowed
        Parameters:
        deleteWhitelistRootPaths - list of root paths under which deletion is allowed
        Returns:
        this DeleteCommandBuilder

      • withShallow

        @Nonnull
DeleteCommandBuilder withShallow​(boolean shallow)
        sets whether to perform a shallow operation
        Parameters:
        shallow - if true only the content of the resource is deleted but not its child resources. only supported for pages. default is false
        Returns:
        this DeleteCommandBuilder

      • withForce

        @Nonnull
DeleteCommandBuilder withForce​(boolean force)
        sets whether to do to force delete
        Parameters:
        force - if false deletion is executed only if selected item(s)
        • are not referenced by any pages
        • don't have any child pages (if checkChildren below is true)
        • don't contain any activated assets
        default is false
        Returns:
        this DeleteCommandBuilder

      • withArchive

        @Nonnull
DeleteCommandBuilder withArchive​(boolean archive)
        sets whether to archive resource before delete
        Parameters:
        archive - if true version will be created for item(s) and its children selected for deletion.
        Returns:
        this DeleteCommandBuilder

      • withCheckChildren

        @Nonnull
DeleteCommandBuilder withCheckChildren​(boolean checkChildren)
        sets whether to check for child pages of selected items while deletion
        Parameters:
        checkChildren - if true, and if force above is false, deletion isn't performed if selected items have child pages. default is false
        Returns:
        this DeleteCommandBuilder

      • withPathArgument

        @Nonnull
DeleteCommandBuilder withPathArgument​(@Nonnull
                                      DeleteCommandPathArgument pathArgument)
        append a path argument
        Parameters:
        pathArgument - the path argument instance
        Returns:
        this DeleteCommandBuilder