info.magnolia.module.delta

Class QueryElementsAndDisplayWarningTask

java.lang.Object

info.magnolia.module.delta.AbstractTask

info.magnolia.module.delta.AbstractRepositoryTask

info.magnolia.module.delta.QueryElementsAndDisplayWarningTask

All Implemented Interfaces:

Task

public class QueryElementsAndDisplayWarningTask
extends AbstractRepositoryTask

Displays user a warning message based on the query statement and workspace passed in.

A warning is displayed only if there is at least one node found by given query.

Field Summary

Fields inherited from class info.magnolia.module.delta.AbstractTask

DO_NOTHING

Constructor Summary

Constructors

Constructor and Description
QueryElementsAndDisplayWarningTask(String name, String description, String workspace, String queryStatement, String baseMessageFormat, List<String> exclusionLists)
QueryElementsAndDisplayWarningTask(String name, String description, String workspace, String queryStatement, String nodeType, String baseMessageFormat, List<String> exclusionLists) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doExecute(InstallContext installContext)

Methods inherited from class info.magnolia.module.delta.AbstractRepositoryTask

execute

Methods inherited from class info.magnolia.module.delta.AbstractTask

getDescription, getName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryElementsAndDisplayWarningTask

public QueryElementsAndDisplayWarningTask(String name,
                                          String description,
                                          String workspace,
                                          String queryStatement,
                                          String nodeType,
                                          String baseMessageFormat,
                                          List<String> exclusionLists)

Default constructor.

Parameters:

name - Name of the task

description - Description of the task

workspace - Name of the workspace to search in

queryStatement - Full query statement

nodeType - The node type of the nodes to aggregate; provide null to display every item

baseMessageFormat - The message format to be displayed, make sure to provide it with a %s placeholder, e.g. "Message start\n%s\nMessage end."

exclusionLists - A list of paths to exclude from being mentioned in warning

QueryElementsAndDisplayWarningTask

public QueryElementsAndDisplayWarningTask(String name,
                                          String description,
                                          String workspace,
                                          String queryStatement,
                                          String baseMessageFormat,
                                          List<String> exclusionLists)

Method Detail

doExecute

protected void doExecute(InstallContext installContext)
                  throws javax.jcr.RepositoryException,
                         TaskExecutionException

Specified by:

doExecute in class AbstractRepositoryTask

Throws:

javax.jcr.RepositoryException

TaskExecutionException