KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > ofbiz > minilang > method > entityops > RemoveValue


1 /*
2  * $Id: RemoveValue.java 5462 2005-08-05 18:35:48Z jonesde $
3  *
4  * Copyright (c) 2001-2005 The Open For Business Project - www.ofbiz.org
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * 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 JavaDoc;
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 $Rev: 5462 $
40  * @since 2.0
41  */
42 public class RemoveValue extends MethodOperation {
43     
44     public static final String JavaDoc module = RemoveValue.class.getName();
45     
46     ContextAccessor valueAcsr;
47     String JavaDoc doCacheClearStr;
48
49     public RemoveValue(Element JavaDoc element, SimpleMethod simpleMethod) {
50         super(element, simpleMethod);
51         valueAcsr = new ContextAccessor(element.getAttribute("value-name"));
52         doCacheClearStr = element.getAttribute("do-cache-clear");
53     }
54
55     public boolean exec(MethodContext methodContext) {
56         boolean doCacheClear = !"false".equals(methodContext.expandString(doCacheClearStr));
57         
58         GenericValue value = (GenericValue) valueAcsr.get(methodContext);
59         if (value == null) {
60             String JavaDoc errMsg = "In remove-value a value was not found with the specified valueAcsr: " + valueAcsr + ", not removing";
61             Debug.logWarning(errMsg, module);
62             methodContext.setErrorReturn(errMsg, simpleMethod);
63             return false;
64         }
65
66         try {
67             methodContext.getDelegator().removeValue(value, doCacheClear);
68         } catch (GenericEntityException e) {
69             String JavaDoc errMsg = "ERROR: Could not complete the " + simpleMethod.getShortDescription() + " process [problem removing the " + valueAcsr + " value: " + e.getMessage() + "]";
70             Debug.logError(e, errMsg, module);
71             methodContext.setErrorReturn(errMsg, simpleMethod);
72             return false;
73         }
74         return true;
75     }
76
77     public String JavaDoc rawString() {
78         // TODO: something more than the empty tag
79 return "<remove-value/>";
80     }
81     public String JavaDoc expandedString(MethodContext methodContext) {
82         // TODO: something more than a stub/dummy
83 return this.rawString();
84     }
85 }
86
Popular Tags