info.magnolia.module.delta

Class NewPropertyTask

java.lang.Object

info.magnolia.module.delta.AbstractTask

info.magnolia.module.delta.PropertyValuesTask

info.magnolia.module.delta.NewPropertyTask

All Implemented Interfaces:

Task

public class NewPropertyTask
extends PropertyValuesTask

Creates a new property. Outputs a warning if the property already exists.

Field Summary

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

DO_NOTHING, log

Constructor Summary

Constructors

Constructor and Description
NewPropertyTask(String name, String nodePath, String propertyName, Object value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, BigDecimal value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, javax.jcr.Binary value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, Boolean value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, Calendar value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, Double value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, InputStream value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, Long value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, javax.jcr.Node value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, String value)
NewPropertyTask(String name, String description, String workspaceName, String nodePath, String propertyName, javax.jcr.Value value)

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(InstallContext ctx) A good-citizen task should execute itself responsibly: it should know what to do in case of problems: for instance, fixable or irrelevant issues should usually just be logged used the InstallContext methods, when the user can fix them later on.

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

checkAndModifyPartOfPropertyValue, checkAndModifyPropertyValue, checkAndModifyPropertyValue, checkAndModifyPropertyValue, checkOrCreateProperty, checkOrCreateProperty, format, format, format, newProperty, newProperty

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

NewPropertyTask

public NewPropertyTask(String name,
               String nodePath,
               String propertyName,
               Object value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               String value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               javax.jcr.Value value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               javax.jcr.Node value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               javax.jcr.Binary value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               Calendar value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               BigDecimal value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               Long value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               Double value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               Boolean value)

NewPropertyTask

public NewPropertyTask(String name,
               String description,
               String workspaceName,
               String nodePath,
               String propertyName,
               InputStream value)

Method Detail

execute

public void execute(InstallContext ctx)

Description copied from interface: Task

A good-citizen task should execute itself responsibly: it should know what to do in case of problems: for instance, fixable or irrelevant issues should usually just be logged used the InstallContext methods, when the user can fix them later on. The task could also potentially do backups of nodes it needs to modify extensively, so the user could refer to the backups in case of problem. In the event of an unrecoverable issue, the Task could also throw a TaskExecutionException, knowing that will cancel the whole module's installation, update and startup. If a TaskExecutionException must be thrown, keep in mind that the exception message will still be shown to the end user, so try to keep them human readable.