| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Initialiser |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * $Source$ | |
| 3 | * $Revision$ | |
| 4 | * | |
| 5 | * Copyright (C) 2000 William Chesters | |
| 6 | * | |
| 7 | * Part of Melati (http://melati.org), a framework for the rapid | |
| 8 | * development of clean, maintainable web applications. | |
| 9 | * | |
| 10 | * Melati is free software; Permission is granted to copy, distribute | |
| 11 | * and/or modify this software under the terms either: | |
| 12 | * | |
| 13 | * a) the GNU General Public License as published by the Free Software | |
| 14 | * Foundation; either version 2 of the License, or (at your option) | |
| 15 | * any later version, | |
| 16 | * | |
| 17 | * or | |
| 18 | * | |
| 19 | * b) any version of the Melati Software License, as published | |
| 20 | * at http://melati.org | |
| 21 | * | |
| 22 | * You should have received a copy of the GNU General Public License and | |
| 23 | * the Melati Software License along with this program; | |
| 24 | * if not, write to the Free Software Foundation, Inc., | |
| 25 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the | |
| 26 | * GNU General Public License and visit http://melati.org to obtain the | |
| 27 | * Melati Software License. | |
| 28 | * | |
| 29 | * Feel free to contact the Developers of Melati (http://melati.org), | |
| 30 | * if you would like to work out a different arrangement than the options | |
| 31 | * outlined here. It is our intention to allow Melati to be used by as | |
| 32 | * wide an audience as possible. | |
| 33 | * | |
| 34 | * This program is distributed in the hope that it will be useful, | |
| 35 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 36 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 37 | * GNU General Public License for more details. | |
| 38 | * | |
| 39 | * Contact details for copyright holder: | |
| 40 | * | |
| 41 | * William Chesters <williamc@paneris.org> | |
| 42 | * http://paneris.org/~williamc | |
| 43 | * Obrechtstraat 114, 2517VX Den Haag, The Netherlands | |
| 44 | */ | |
| 45 | ||
| 46 | package org.melati.poem; | |
| 47 | ||
| 48 | /** | |
| 49 | * A piece of code for initialising a newly created {@link Persistent} | |
| 50 | * object in a POEM {@link Table}. | |
| 51 | * Much like a Java constructor. You will probably want to define these as | |
| 52 | * anonymous classes. | |
| 53 | * | |
| 54 | * @author WilliamC At paneris.org | |
| 55 | * @see Table#create(org.melati.poem.Initialiser) | |
| 56 | */ | |
| 57 | ||
| 58 | public interface Initialiser { | |
| 59 | ||
| 60 | /** | |
| 61 | * Initialise a freshly generated POEM object. | |
| 62 | * | |
| 63 | * @param object A <TT>Persistent</TT> representing the new object, or, | |
| 64 | * if the table was defined in the DSD under the name | |
| 65 | * <TT><I>foo</I></TT>, an application-specialised | |
| 66 | * subclass <TT><I>Foo</I></TT> of <TT>Persistent</TT>. | |
| 67 | * You should call its <TT>setRaw</TT> and/or | |
| 68 | * <TT>setCooked</TT> methods to get it into a state which | |
| 69 | * is (a) legal, in that all its fields have valid values, | |
| 70 | * and (b) writeable by you (the <TT>AccessToken</TT> of | |
| 71 | * the calling thread). | |
| 72 | * | |
| 73 | * @exception AccessPoemException | |
| 74 | * you will not provoke an <TT>AccessPoemException</TT> during | |
| 75 | * initialisation (while this method is running) unless the | |
| 76 | * application-specialised <TT>Persistent</TT> throws one | |
| 77 | * explicitly, because POEM's standard checks are disabled; | |
| 78 | * however, after this method returns, the object you have | |
| 79 | * initialised will be checked to ensure that you have write | |
| 80 | * access to it | |
| 81 | * | |
| 82 | * @see PoemThread#accessToken() | |
| 83 | * @see Table#create(org.melati.poem.Initialiser) | |
| 84 | */ | |
| 85 | ||
| 86 | void init(Persistent object) | |
| 87 | throws AccessPoemException, ValidationPoemException; | |
| 88 | } |