01: /*
02: * Copyright 2005-2007 The Kuali Foundation.
03: *
04: *
05: * Licensed under the Educational Community License, Version 1.0 (the "License");
06: * you may not use this file except in compliance with the License.
07: * You may obtain a copy of the License at
08: *
09: * http://www.opensource.org/licenses/ecl1.php
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.kuali.workflow.tools.xml;
18:
19: import java.util.List;
20:
21: /**
22: * Can be "plugged-in" to the XmlGen tool to assist with rule description generation and attribute
23: * field resolution.
24: *
25: * @author ewestfal
26: */
27: public abstract class XmlGenHelper {
28:
29: /**
30: * Return a description for the given rule. If a null or empty value is returned, then XmlGen will generate
31: * a default description for the rule using rule data. This method is only called if a description is
32: * not defined for the rule on the spreadsheet.
33: */
34: public abstract String generateRuleDescription(Rule rule);
35:
36: /**
37: * Return a List of field names for the given attribute. This is only invoked for those attributes which
38: * aren't defined in XML. In those cases we need to be able to determine what data fields are
39: * available on the attribute and, therefore, the rules.
40: */
41: public abstract List<String> resolveFieldNames(Attribute attribute);
42:
43: }
|