01: /*
02: * ====================================================================
03: * JAFFA - Java Application Framework For All
04: *
05: * Copyright (C) 2002 JAFFA Development Group
06: *
07: * This library is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU Lesser General Public
09: * License as published by the Free Software Foundation; either
10: * version 2.1 of the License, or (at your option) any later version.
11: *
12: * This library is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this library; if not, write to the Free Software
19: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20: *
21: * Redistribution and use of this software and associated documentation ("Software"),
22: * with or without modification, are permitted provided that the following conditions are met:
23: * 1. Redistributions of source code must retain copyright statements and notices.
24: * Redistributions must also contain a copy of this document.
25: * 2. Redistributions in binary form must reproduce the above copyright notice,
26: * this list of conditions and the following disclaimer in the documentation
27: * and/or other materials provided with the distribution.
28: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
29: * this Software without prior written permission. For written permission,
30: * please contact mail to: jaffagroup@yahoo.com.
31: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
32: * appear in their names without prior written permission.
33: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
34: *
35: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
36: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46: * SUCH DAMAGE.
47: * ====================================================================
48: */
49:
50: package org.jaffa.components.maint;
51:
52: import org.jaffa.components.dto.HeaderDto;
53: import org.jaffa.util.StringHelper;
54:
55: /** This is the helper class for all Maintenance Tx (transaction) classes.
56: * It is provided to support repetitive functions.
57: * @author GautamJ
58: */
59: public class MaintTx {
60:
61: /** This is a helper for combining old and additional comments.
62: * A stamp containing the userId and current time will be inserted before the additional comment.
63: * The additional comment will be inserted before the old comment if 'lifo' is true, otherwise it'll be appended.
64: * @param originalComment The original comment.
65: * @param additionalComment The additional comment.
66: * @param lifo This determines if the additional comment is inserted before or appended after the old comment.
67: * @param headerDto The headerDto containing the userId.
68: * @return The combination of the old comment and the additional comment.
69: * @deprecated This function is now provided by the StringHelper class.
70: */
71: public static String addCommentWithStamp(String originalComment,
72: String additionalComment, boolean lifo, HeaderDto headerDto) {
73: return StringHelper.addCommentWithStamp(originalComment,
74: additionalComment, lifo, headerDto != null ? headerDto
75: .getUserId() : null);
76: }
77:
78: }
|