01: /*
02: * Copyright (c) 2001 - 2005 ivata limited.
03: * All rights reserved.
04: * -----------------------------------------------------------------------------
05: * ivata groupware may be redistributed under the GNU General Public
06: * License as published by the Free Software Foundation;
07: * version 2 of the License.
08: *
09: * These programs are free software; you can redistribute them and/or
10: * modify them under the terms of the GNU General Public License
11: * as published by the Free Software Foundation; version 2 of the License.
12: *
13: * These programs are distributed in the hope that they will be useful,
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16: *
17: * See the GNU General Public License in the file LICENSE.txt for more
18: * details.
19: *
20: * If you would like a copy of the GNU General Public License write to
21: *
22: * Free Software Foundation, Inc.
23: * 59 Temple Place - Suite 330
24: * Boston, MA 02111-1307, USA.
25: *
26: *
27: * To arrange commercial support and licensing, contact ivata at
28: * http://www.ivata.com/contact.jsp
29: * -----------------------------------------------------------------------------
30: * $Log: AuthorDO.java,v $
31: * Revision 1.2 2005/10/03 10:21:15 colinmacleod
32: * Fixed some style and javadoc issues.
33: *
34: * Revision 1.1 2005/09/29 12:50:40 colinmacleod
35: * Restructured NamedDO and TimestampDO classes based around interfaces.
36: *
37: * -----------------------------------------------------------------------------
38: */
39: package com.ivata.groupware.container.persistence;
40:
41: import com.ivata.groupware.admin.security.user.UserDO;
42:
43: /**
44: * Data objects implementing this interface define who created and modified
45: * them.
46: *
47: * @author Colin MacLeod
48: * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
49: * @since ivata groupware 1.0 (2005-09-28)
50: * @version $Revision: 1.2 $
51: */
52: public interface AuthorDO {
53: /**
54: * <p>Get the user who created this DO.</p>
55: *
56: * @return the user who created this DO.
57: * @hibernate.many-to-one
58: * column="created_by"
59: */
60: public abstract UserDO getCreatedBy();
61:
62: /**
63: * <p>Get the username of the user who last modified this DO.</p>
64: *
65: * @return the user name for the user who last modified this DO.
66: * @hibernate.many-to-one
67: * column="modified_by"
68: */
69: public abstract UserDO getModifiedBy();
70:
71: /**
72: * <copyDoc>Refer to {@link #getCreatedBy}.</copyDoc>
73: * @param createdByParam The createdBy to set.
74: */
75: public abstract void setCreatedBy(UserDO createdByParam);
76:
77: /**
78: * <copyDoc>Refer to {@link #getModifiedBy}.</copyDoc>
79: * @param modifiedByParam The modifiedBy to set.
80: */
81: public abstract void setModifiedBy(UserDO modifiedByParam);
82:
83: }
|