01: /*
02: * $Id: RemoveValue.java,v 1.2 2003/09/14 05:40:41 jonesde Exp $
03: *
04: * Copyright (c) 2001, 2002 The Open For Business Project - www.ofbiz.org
05: *
06: * Permission is hereby granted, free of charge, to any person obtaining a
07: * copy of this software and associated documentation files (the "Software"),
08: * to deal in the Software without restriction, including without limitation
09: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10: * and/or sell copies of the Software, and to permit persons to whom the
11: * Software is furnished to do so, subject to the following conditions:
12: *
13: * The above copyright notice and this permission notice shall be included
14: * in all copies or substantial portions of the Software.
15: *
16: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17: * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20: * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
21: * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
22: * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23: */
24: package org.ofbiz.minilang.method.entityops;
25:
26: import org.ofbiz.base.util.Debug;
27: import org.ofbiz.entity.GenericEntityException;
28: import org.ofbiz.entity.GenericValue;
29: import org.ofbiz.minilang.SimpleMethod;
30: import org.ofbiz.minilang.method.ContextAccessor;
31: import org.ofbiz.minilang.method.MethodContext;
32: import org.ofbiz.minilang.method.MethodOperation;
33: import org.w3c.dom.Element;
34:
35: /**
36: * Uses the delegator to remove the specified value object entity from the datasource
37: *
38: * @author <a href="mailto:jonesde@ofbiz.org">David E. Jones</a>
39: * @version $Revision: 1.2 $
40: * @since 2.0
41: */
42: public class RemoveValue extends MethodOperation {
43:
44: public static final String module = RemoveValue.class.getName();
45:
46: ContextAccessor valueAcsr;
47: String doCacheClearStr;
48:
49: public RemoveValue(Element element, SimpleMethod simpleMethod) {
50: super (element, simpleMethod);
51: valueAcsr = new ContextAccessor(element
52: .getAttribute("value-name"));
53: doCacheClearStr = element.getAttribute("do-cache-clear");
54: }
55:
56: public boolean exec(MethodContext methodContext) {
57: boolean doCacheClear = !"false".equals(methodContext
58: .expandString(doCacheClearStr));
59:
60: GenericValue value = (GenericValue) valueAcsr
61: .get(methodContext);
62: if (value == null) {
63: String errMsg = "In remove-value a value was not found with the specified valueAcsr: "
64: + valueAcsr + ", not removing";
65: Debug.logWarning(errMsg, module);
66: methodContext.setErrorReturn(errMsg, simpleMethod);
67: return false;
68: }
69:
70: try {
71: methodContext.getDelegator().removeValue(value,
72: doCacheClear);
73: } catch (GenericEntityException e) {
74: String errMsg = "ERROR: Could not complete the "
75: + simpleMethod.getShortDescription()
76: + " process [problem removing the " + valueAcsr
77: + " value: " + e.getMessage() + "]";
78: Debug.logError(e, errMsg, module);
79: methodContext.setErrorReturn(errMsg, simpleMethod);
80: return false;
81: }
82: return true;
83: }
84: }
|