KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: RemoveRelated.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 entities related to the specified value object 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 RemoveRelated extends MethodOperation {
43     
44     public static final String JavaDoc module = RemoveRelated.class.getName();
45     
46     ContextAccessor valueAcsr;
47     String JavaDoc relationName;
48     String JavaDoc doCacheClearStr;
49
50     public RemoveRelated(Element JavaDoc element, SimpleMethod simpleMethod) {
51         super(element, simpleMethod);
52         valueAcsr = new ContextAccessor(element.getAttribute("value-name"));
53         relationName = element.getAttribute("relation-name");
54         doCacheClearStr = element.getAttribute("do-cache-clear");
55     }
56
57     public boolean exec(MethodContext methodContext) {
58         boolean doCacheClear = !"false".equals(doCacheClearStr);
59         String JavaDoc relationName = methodContext.expandString(this.relationName);
60         
61         GenericValue value = (GenericValue) valueAcsr.get(methodContext);
62         if (value == null) {
63             String JavaDoc errMsg = "In remove-related a value was not found with the specified valueAcsr: " + valueAcsr + ", not removing related";
64
65             Debug.logWarning(errMsg, module);
66             if (methodContext.getMethodType() == MethodContext.EVENT) {
67                 methodContext.putEnv(simpleMethod.getEventErrorMessageName(), errMsg);
68                 methodContext.putEnv(simpleMethod.getEventResponseCodeName(), simpleMethod.getDefaultErrorCode());
69             } else if (methodContext.getMethodType() == MethodContext.SERVICE) {
70                 methodContext.putEnv(simpleMethod.getServiceErrorMessageName(), errMsg);
71                 methodContext.putEnv(simpleMethod.getServiceResponseMessageName(), simpleMethod.getDefaultErrorCode());
72             }
73             return false;
74         }
75
76         try {
77             methodContext.getDelegator().removeRelated(relationName, value, doCacheClear);
78         } catch (GenericEntityException e) {
79             Debug.logError(e, module);
80             String JavaDoc errMsg = "ERROR: Could not complete the " + simpleMethod.getShortDescription() + " process [problem removing the relation " + relationName + " of the value " + valueAcsr + " value: " + e.getMessage() + "]";
81
82             if (methodContext.getMethodType() == MethodContext.EVENT) {
83                 methodContext.putEnv(simpleMethod.getEventErrorMessageName(), errMsg);
84                 methodContext.putEnv(simpleMethod.getEventResponseCodeName(), simpleMethod.getDefaultErrorCode());
85             } else if (methodContext.getMethodType() == MethodContext.SERVICE) {
86                 methodContext.putEnv(simpleMethod.getServiceErrorMessageName(), errMsg);
87                 methodContext.putEnv(simpleMethod.getServiceResponseMessageName(), simpleMethod.getDefaultErrorCode());
88             }
89             return false;
90         }
91         return true;
92     }
93
94     public String JavaDoc rawString() {
95         // TODO: something more than the empty tag
96
return "<remove-related/>";
97     }
98     public String JavaDoc expandedString(MethodContext methodContext) {
99         // TODO: something more than a stub/dummy
100
return this.rawString();
101     }
102 }
103
Popular Tags