001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064:
065: package com.jcorporate.expresso.services.dbobj;
066:
067: import com.jcorporate.expresso.core.db.DBException;
068: import com.jcorporate.expresso.core.dbobj.RequestContext;
069: import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
070: import com.jcorporate.expresso.core.dbobj.ValidValue;
071: import com.jcorporate.expresso.core.security.User;
072:
073: import java.util.Vector;
074:
075: /**
076: * EventMail objects tell who is to be notified when an event is triggered
077: *
078: * @author Michael Nash
079: * @version $Revision: 1.12 $ $Date: 2004/11/18 02:03:30 $
080: */
081: public class EventMail extends SecuredDBObject {
082: /**
083: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject
084: */
085: public EventMail() throws DBException {
086: super ();
087: } /* EventMail() */
088:
089: /**
090: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject
091: *
092: * @param theUser
093: * @throws DBException
094: */
095: // public EventMail(String theUser)
096: // throws DBException {
097: // super(theUser);
098: // } /* EventMail(String) */
099: /**
100: * @param uid the Expresso security user id
101: * @throws DBException upon initialization error
102: */
103: public EventMail(int uid) throws DBException {
104: super (uid);
105: }
106:
107: /**
108: * For using DBObjects within Controllers. Initializes based upon the current
109: * user and the requested db. [Of course this can be modified later]
110: *
111: * @param request - The controller request handed to you by the framework.
112: * @throws DBException upon initialization error
113: */
114: public EventMail(RequestContext request) throws DBException {
115: super (request);
116: }
117:
118: /**
119: * Extends the checkAllRefs method to check for valid User and Event
120: *
121: * @throws DBException If a referential integrity violation is found
122: */
123: protected void checkAllRefs() throws DBException {
124: checkRef("Event", new Event(), "Invalid "
125: + getString(getMetaData().getDescription("Event")));
126: } /* checkAllRefs() */
127:
128: /**
129: * Override the method getValidValues to provide specific values for our
130: * multi-valued fields
131: *
132: * @param fieldName Name of the field for which values are requested
133: * @return Vector of ValidValue Value/description pairs for
134: * the valid values
135: * @throws DBException If the values cannot be retrieved
136: */
137: public synchronized Vector getValidValues(String fieldName)
138: throws DBException {
139: if (fieldName.equals("Success")) {
140: Vector myValues = new Vector(2);
141: myValues.addElement(new ValidValue("Y", "Yes"));
142: myValues.addElement(new ValidValue("N", "No"));
143:
144: return myValues;
145: }
146:
147: return super .getValidValues(fieldName);
148: } /* getValidValues(String) */
149:
150: /**
151: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#setupFields
152: */
153: protected synchronized void setupFields() throws DBException {
154: setTargetTable("EVENTMAIL");
155: setDescription("DBeventMail");
156: setCharset("ISO-8859-1");
157: addField("Event", "char", 30, false, "eventCode");
158: addField("ExpUid", "int", 0, false, "userId");
159: addVirtualField("LoginName", "char", 30, "loginName");
160: addField("Success", "char", 1, false, "userNotifiedOnSuccess");
161: addKey("Event");
162: addKey("ExpUid");
163: addKey("Success");
164: setStringFilter("Event", "stripFilter");
165: setMultiValued("Event");
166: setMultiValued("Success");
167: setLookupObject("Event",
168: "com.jcorporate.expresso.services.dbobj.Event");
169: setLookupObject("ExpUid",
170: "com.jcorporate.expresso.core.security.User");
171: } /* setupFields() */
172:
173: /**
174: * Extend the usual getField method to return values for the virtual field
175: *
176: * @param fieldName the name of the field to retrieve the value.
177: * @return java.lang.String the field value
178: * @throws DBException upon initialization error
179: */
180: public String getField(String fieldName) throws DBException {
181: if (fieldName.equals("LoginName")) {
182: User u = new User();
183: u.setUid(getFieldInt("ExpUid"));
184: u.setDataContext(this .getDataContext());
185:
186: if (u.find()) {
187: return u.getLoginName();
188: }
189:
190: return "No such user";
191: }
192:
193: return super .getField(fieldName);
194: }
195:
196: /**
197: * @throws DBException
198: */
199: public synchronized void populateDefaultValues() throws DBException {
200: int adminId = User.getAdminId(getDataContext());
201:
202: //SYSERROR
203: EventMail oneMail = new EventMail();
204: oneMail.setDataContext(getDataContext());
205: oneMail.setField("Event", "SYSERROR");
206: oneMail.setField("ExpUid", adminId);
207: oneMail.setField("Success", "Y");
208:
209: if (!oneMail.find()) {
210: oneMail.add();
211: }
212:
213: oneMail.clear();
214: oneMail.setField("Event", "SYSERROR");
215: oneMail.setField("ExpUid", adminId);
216: oneMail.setField("Success", "N");
217:
218: if (!oneMail.find()) {
219: oneMail.add();
220: }
221:
222: //HEALTHCHECK
223: oneMail.clear();
224: oneMail.setField("Event", "HEALTH");
225: oneMail.setField("ExpUid", adminId);
226: oneMail.setField("Success", "Y");
227:
228: if (!oneMail.find()) {
229: oneMail.add();
230: }
231:
232: oneMail.clear();
233: oneMail.setField("Event", "HEALTH");
234: oneMail.setField("ExpUid", adminId);
235: oneMail.setField("Success", "N");
236:
237: if (!oneMail.find()) {
238: oneMail.add();
239: }
240:
241: //DOWNLOAD
242: oneMail.clear();
243: oneMail.setDataContext(getDataContext());
244: oneMail.setField("Event", "DOWNLOAD");
245: oneMail.setField("ExpUid", adminId);
246: oneMail.setField("Success", "Y");
247:
248: if (!oneMail.find()) {
249: oneMail.add();
250: }
251:
252: oneMail.clear();
253: oneMail.setDataContext(getDataContext());
254: oneMail.setField("Event", "DOWNLOAD");
255: oneMail.setField("ExpUid", adminId);
256: oneMail.setField("Success", "N");
257:
258: if (!oneMail.find()) {
259: oneMail.add();
260: }
261:
262: //REGISTER
263: oneMail.clear();
264: oneMail.setDataContext(getDataContext());
265: oneMail.setField("Event", "REGISTER");
266: oneMail.setField("ExpUid", adminId);
267: oneMail.setField("Success", "Y");
268:
269: if (!oneMail.find()) {
270: oneMail.add();
271: }
272:
273: oneMail.clear();
274: oneMail.setDataContext(getDataContext());
275: oneMail.setField("Event", "REGISTER");
276: oneMail.setField("ExpUid", adminId);
277: oneMail.setField("Success", "N");
278:
279: if (!oneMail.find()) {
280: oneMail.add();
281: }
282: } /* populateDefaultValues() */
283:
284: } /* EventMail */
285:
286: /* EventMail */
|