@ProviderType public interface DeleteCommandBuilder extends CommandBuilder
Modifier and Type | Method and Description |
---|---|
DeleteCommandPathArgumentBuilder |
createPathArgumentBuilder() |
DeleteCommandBuilder |
withAssetReferenceResolver(AssetReferenceResolver assetRefResolver)
sets the reference resolver to access references
|
DeleteCommandBuilder |
withCheckChildren(boolean checkChildren)
sets whether to check for child pages of selected items while deletion
|
DeleteCommandBuilder |
withDeleteWhitelistRootPaths(java.lang.String[] deleteWhitelistRootPaths)
set whitelist of root paths where deletion is allowed
|
DeleteCommandBuilder |
withForce(boolean force)
sets whether to do to force delete
|
DeleteCommandBuilder |
withI18N(I18n i18n)
initializes the
I18n object for the command builder |
DeleteCommandBuilder |
withPageManager(PageManager pageManager)
initializes the
PageManager which provides methods for page level operations |
DeleteCommandBuilder |
withPathArgument(DeleteCommandPathArgument pathArgument)
append a path argument
|
DeleteCommandBuilder |
withPredicateProvider(PredicateProvider predicateProvider)
initializes the
PredicateProvider for the command builder |
DeleteCommandBuilder |
withReplicator(Replicator replicator)
initializes the
Replicator for the command builder |
DeleteCommandBuilder |
withResourceResolver(ResourceResolver resourceResolver)
initializes the
ResourceResolver for the command builder |
DeleteCommandBuilder |
withShallow(boolean shallow)
sets whether to perform a shallow operation
|
build
@Nonnull DeleteCommandBuilder withResourceResolver(@Nonnull ResourceResolver resourceResolver)
ResourceResolver
for the command builderresourceResolver
- the resource resolver for the command builderDeleteCommandBuilder
@Nonnull DeleteCommandBuilder withPageManager(@Nonnull PageManager pageManager)
PageManager
which provides methods for page level operationsDeleteCommandBuilder
@Nonnull DeleteCommandBuilder withI18N(@Nonnull I18n i18n)
I18n
object for the command builderi18n
- the internationalization object for the command builderDeleteCommandBuilder
@Nonnull DeleteCommandBuilder withReplicator(@Nonnull Replicator replicator)
Replicator
for the command builderreplicator
- the replicator for the command builderDeleteCommandBuilder
@Nonnull DeleteCommandBuilder withAssetReferenceResolver(@Nonnull AssetReferenceResolver assetRefResolver)
assetRefResolver
- the AssetReferenceResolver
to get referencesDeleteCommandBuilder
@Nonnull DeleteCommandBuilder withPredicateProvider(@Nonnull PredicateProvider predicateProvider)
PredicateProvider
for the command builderpredicateProvider
- the predicate provider for the command builderDeleteCommandBuilder
@Nonnull DeleteCommandBuilder withDeleteWhitelistRootPaths(@Nonnull java.lang.String[] deleteWhitelistRootPaths)
deleteWhitelistRootPaths
- list of root paths under which deletion is allowedDeleteCommandBuilder
@Nonnull DeleteCommandBuilder withShallow(boolean shallow)
shallow
- if true
only the content of the resource is deleted
but not its child resources. only supported for pages. default is falseDeleteCommandBuilder
@Nonnull DeleteCommandBuilder withForce(boolean force)
force
- if false
deletion is executed only if selected item(s)
checkChildren
below is true) DeleteCommandBuilder
@Nonnull DeleteCommandBuilder withCheckChildren(boolean checkChildren)
checkChildren
- if true
, and if force
above is false, deletion
isn't performed if selected items have child pages. default is falseDeleteCommandBuilder
@Nonnull DeleteCommandPathArgumentBuilder createPathArgumentBuilder()
@Nonnull DeleteCommandBuilder withPathArgument(@Nonnull DeleteCommandPathArgument pathArgument)
pathArgument
- the path argument instanceDeleteCommandBuilder
Copyright © 2010 - 2020 Adobe. All Rights Reserved