01: /*
02: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Portal/Sources/es/udc/mypersonalizer/portal/model/wizards/PropertyUpdater.java,v 1.1.1.1 2004/03/25 12:08:40 fbellas Exp $
03: * $Revision: 1.1.1.1 $
04: * $Date: 2004/03/25 12:08:40 $
05: *
06: * =============================================================================
07: *
08: * Copyright (c) 2003, The MyPersonalizer Development Group
09: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
10: * University Of A Coruna
11: * All rights reserved.
12: *
13: * Redistribution and use in source and binary forms, with or without
14: * modification, are permitted provided that the following conditions are met:
15: *
16: * - Redistributions of source code must retain the above copyright notice,
17: * this list of conditions and the following disclaimer.
18: *
19: * - Redistributions in binary form must reproduce the above copyright notice,
20: * this list of conditions and the following disclaimer in the documentation
21: * and/or other materials provided with the distribution.
22: *
23: * - Neither the name of the University Of A Coruna nor the names of its
24: * contributors may be used to endorse or promote products derived from
25: * this software without specific prior written permission.
26: *
27: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37: * POSSIBILITY OF SUCH DAMAGE.
38: *
39: */
40:
41: package es.udc.mypersonalizer.portal.model.wizards;
42:
43: import es.udc.mypersonalizer.kernel.model.properties.Property;
44: import es.udc.mypersonalizer.kernel.util.exceptions.InternalErrorException;
45: import es.udc.mypersonalizer.portal.model.types.WizardEvent;
46:
47: /**
48: * This interface defines the PropertyUpdaters. These are objects responsible
49: * for updating properties in different manners. These can be used to create
50: * a new property, remove it, update... each different class implementing
51: * this interface will perform a different operation, based on the data
52: * supplied in a {@link WizardEvent} object.<p>
53: *
54: * The PropertyUpdaters are registered in {@link
55: * PropertyUpdaterRegistrySingleton}, which reads the instances to register
56: * from configuration.<p>
57: *
58: * The normal system operation requires the following property updaters:
59: * <ul>
60: * <li><tt>addPropertyStructure</tt>: Updater which will be responsible for
61: * adding a new value to a multi-valued property, this is, to add a new
62: * {@link es.udc.mypersonalizer.kernel.model.properties.PropertyStructure}
63: * to it as a value.</li>
64: * <li><tt>removePropertyStructure</tt>: This updater will be responsible for
65: * removing a value (a {@link
66: * es.udc.mypersonalizer.kernel.model.properties.PropertyStructure}) from
67: * a multi-valued Property.</li>
68: * <li><tt>updateSimpleProperties</tt>: This updater will modify the values
69: * of a given {@link
70: * es.udc.mypersonalizer.kernel.model.properties.PropertyStructure}
71: * inside a Property and modify them to match the values given in a
72: * {@link WizardEvent} object.</li>
73: * </ul>
74: *
75: * @author Daniel Fernandez
76: * @since 1.0
77: */
78: public interface PropertyUpdater {
79:
80: /**
81: * This method performs the action for which the updater object is
82: * responsible. This can be add, modify, update... taking the needed data
83: * from a {@link WizardEvent} object and acting on a given
84: * {@link Property}.<p>
85: *
86: * The exact point of the Property tree where the action will be applied
87: * is established by the <tt>propertyStructureName</tt> of the
88: * wizard event.
89: *
90: * @param property the property which will receive the action.
91: * @param event the event which contains the data to add, update, etc.
92: * @throws InternalErrorException if any fatal errors occur.
93: */
94: public void update(Property property, WizardEvent event)
95: throws InternalErrorException;
96:
97: }
|