1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 package org.kuali.rice.kew.rule.bo;
17
18 import org.apache.commons.lang.ArrayUtils;
19 import org.hibernate.annotations.Fetch;
20 import org.hibernate.annotations.FetchMode;
21 import org.hibernate.annotations.GenericGenerator;
22 import org.hibernate.annotations.Parameter;
23 import org.kuali.rice.kew.api.KewApiConstants;
24 import org.kuali.rice.kew.api.rule.RoleName;
25 import org.kuali.rice.kew.api.rule.RuleTemplate;
26 import org.kuali.rice.kew.api.rule.RuleTemplateContract;
27 import org.kuali.rice.kew.rule.RuleTemplateOptionBo;
28 import org.kuali.rice.kew.service.KEWServiceLocator;
29 import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
30
31 import javax.persistence.CascadeType;
32 import javax.persistence.Column;
33 import javax.persistence.Entity;
34 import javax.persistence.FetchType;
35 import javax.persistence.GeneratedValue;
36 import javax.persistence.Id;
37 import javax.persistence.JoinColumn;
38 import javax.persistence.NamedQueries;
39 import javax.persistence.NamedQuery;
40 import javax.persistence.OneToMany;
41 import javax.persistence.OneToOne;
42 import javax.persistence.Table;
43 import javax.persistence.Transient;
44 import java.net.URLEncoder;
45 import java.util.ArrayList;
46 import java.util.Collections;
47 import java.util.Iterator;
48 import java.util.List;
49
50
51
52
53
54
55
56
57
58 @Entity
59 @Table(name="KREW_RULE_TMPL_T")
60
61 @NamedQueries({@NamedQuery(name="findAllOrderedByName", query="SELECT rt FROM RuleTemplate rt ORDER BY rt.name ASC")})
62 public class RuleTemplateBo extends PersistableBusinessObjectBase implements RuleTemplateContract {
63
64 private static final long serialVersionUID = -3387940485523951302L;
65
66
67
68
69 public static final String[] DEFAULT_OPTION_KEYS = {
70
71 KewApiConstants.ACTION_REQUEST_ACKNOWLEDGE_REQ,
72 KewApiConstants.ACTION_REQUEST_APPROVE_REQ,
73 KewApiConstants.ACTION_REQUEST_COMPLETE_REQ,
74 KewApiConstants.ACTION_REQUEST_FYI_REQ,
75 KewApiConstants.ACTION_REQUEST_DEFAULT_CD
76 };
77
78 @Id
79 @GeneratedValue(generator="KREW_RTE_TMPL_S")
80 @GenericGenerator(name="KREW_RTE_TMPL_S",strategy="org.hibernate.id.enhanced.SequenceStyleGenerator",parameters={
81 @Parameter(name="sequence_name",value="KREW_RTE_TMPL_S"),
82 @Parameter(name="value_column",value="id")
83 })
84 @Column(name="RULE_TMPL_ID")
85 private String id;
86 @Column(name="NM")
87 private String name;
88 @Column(name="RULE_TMPL_DESC")
89 private String description;
90
91 @Column(name="DLGN_RULE_TMPL_ID", insertable=false, updatable=false)
92 private String delegationTemplateId;
93 @OneToOne(fetch=FetchType.EAGER)
94 @JoinColumn(name="DLGN_RULE_TMPL_ID")
95 private RuleTemplateBo delegationTemplate;
96 @Fetch(value = FetchMode.SELECT)
97 @OneToMany(fetch=FetchType.EAGER, cascade={CascadeType.PERSIST, CascadeType.REMOVE, CascadeType.MERGE},
98 mappedBy="ruleTemplate")
99 private List<RuleTemplateAttributeBo> ruleTemplateAttributes;
100 @Fetch(value = FetchMode.SELECT)
101 @OneToMany(fetch=FetchType.EAGER, cascade={CascadeType.PERSIST, CascadeType.REMOVE, CascadeType.MERGE},
102 mappedBy="ruleTemplate", orphanRemoval=true)
103 private List<RuleTemplateOptionBo> ruleTemplateOptions;
104
105
106 @Transient
107 private String returnUrl;
108
109 public RuleTemplateBo() {
110 ruleTemplateAttributes = new ArrayList<RuleTemplateAttributeBo>();
111 ruleTemplateOptions = new ArrayList<RuleTemplateOptionBo>();
112 }
113
114
115
116
117
118 public void removeNonDefaultOptions() {
119 Iterator<RuleTemplateOptionBo> it = ruleTemplateOptions.iterator();
120 while (it.hasNext()) {
121 RuleTemplateOptionBo option = it.next();
122
123 if (!ArrayUtils.contains(DEFAULT_OPTION_KEYS, option.getCode())) {
124 it.remove();
125 }
126 }
127 }
128
129 public String getDelegateTemplateName() {
130 if (delegationTemplate != null) {
131 return delegationTemplate.getName();
132 }
133 return "";
134 }
135
136 public String getRuleTemplateActionsUrl() {
137 return "<a href=\"RuleTemplate.do?methodToCall=report¤tRuleTemplateId=" + id + "\" >report</a>"
138 }
139
140
141
142
143
144 private RuleTemplateAttributeBo getRuleTemplateAttribute(RuleTemplateAttributeBo ruleTemplateAttribute, Boolean active) {
145 for (RuleTemplateAttributeBo currentRuleTemplateAttribute: getRuleTemplateAttributes()) {
146 if (currentRuleTemplateAttribute.getRuleAttribute().getName().equals(ruleTemplateAttribute.getRuleAttribute().getName())) {
147 if (active == null) {
148 return currentRuleTemplateAttribute;
149 }
150 else if (active.compareTo(currentRuleTemplateAttribute.getActive()) == 0) {
151 return currentRuleTemplateAttribute;
152 }
153 }
154 }
155 return null;
156 }
157
158 public RuleTemplateAttributeBo getRuleTemplateAttribute(RuleTemplateAttributeBo ruleTemplateAttribute) {
159 return getRuleTemplateAttribute(ruleTemplateAttribute, null);
160 }
161
162 public boolean containsActiveRuleTemplateAttribute(RuleTemplateAttributeBo templateAttribute) {
163 return (getRuleTemplateAttribute(templateAttribute, Boolean.TRUE) != null);
164 }
165
166 public boolean containsRuleTemplateAttribute(RuleTemplateAttributeBo templateAttribute) {
167 return (getRuleTemplateAttribute(templateAttribute, null) != null);
168 }
169
170 public RuleTemplateAttributeBo getRuleTemplateAttribute(int index) {
171 while (getRuleTemplateAttributes().size() <= index) {
172 getRuleTemplateAttributes().add(new RuleTemplateAttributeBo());
173 }
174 return (RuleTemplateAttributeBo) getRuleTemplateAttributes().get(index);
175 }
176
177 public List<RuleTemplateAttributeBo> getRuleTemplateAttributes() {
178 Collections.sort(ruleTemplateAttributes);
179 return ruleTemplateAttributes;
180 }
181
182
183
184
185
186
187 public List<RuleTemplateAttributeBo> getActiveRuleTemplateAttributes() {
188 List<RuleTemplateAttributeBo> activeAttributes = new ArrayList<RuleTemplateAttributeBo>();
189 for (RuleTemplateAttributeBo templateAttribute : getRuleTemplateAttributes())
190 {
191 if (templateAttribute.isActive())
192 {
193 activeAttributes.add(templateAttribute);
194 }
195 }
196 Collections.sort(activeAttributes);
197 return activeAttributes;
198 }
199
200
201
202
203
204 public void setActiveRuleTemplateAttributes(List<RuleTemplateAttributeBo> ruleTemplateAttributes) {
205 throw new UnsupportedOperationException("setActiveRuleTemplateAttributes is not implemented");
206 }
207
208 public void setRuleTemplateAttributes(List<RuleTemplateAttributeBo> ruleTemplateAttributes) {
209 this.ruleTemplateAttributes = ruleTemplateAttributes;
210 }
211
212 public String getDescription() {
213 return description;
214 }
215
216 public void setDescription(String description) {
217 this.description = description;
218 }
219
220 public String getName() {
221 return name;
222 }
223
224 public void setName(String name) {
225 this.name = name;
226 }
227
228 public String getId() {
229 return id;
230 }
231
232 public void setId(String id) {
233 this.id = id;
234 }
235
236 public String getDelegationTemplateId() {
237 return delegationTemplateId;
238 }
239
240 public void setDelegationTemplateId(String delegationTemplateId) {
241 this.delegationTemplateId = delegationTemplateId;
242 }
243
244 public RuleTemplateBo getDelegationTemplate() {
245 return delegationTemplate;
246 }
247
248 public void setDelegationTemplate(RuleTemplateBo delegationTemplate) {
249 this.delegationTemplate = delegationTemplate;
250 }
251
252 public String getReturnUrl() {
253 return returnUrl;
254 }
255
256 public void setReturnUrl(String returnUrl) {
257 this.returnUrl = returnUrl;
258 }
259
260
261
262
263 public String getEncodedName() {
264 return URLEncoder.encode(getName());
265 }
266
267 public List<RuleTemplateOptionBo> getRuleTemplateOptions() {
268 return ruleTemplateOptions;
269 }
270
271 public void setRuleTemplateOptions(List<RuleTemplateOptionBo> ruleTemplateOptions) {
272 this.ruleTemplateOptions = ruleTemplateOptions;
273 }
274
275 public RuleTemplateOptionBo getRuleTemplateOption(String key) {
276 for (RuleTemplateOptionBo option: ruleTemplateOptions) {
277 if (option.getCode().equals(key)) {
278 return option;
279 }
280 }
281 return null;
282 }
283
284 public void setAcknowledge(RuleTemplateOptionBo acknowledge) {
285 RuleTemplateOptionBo option = getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_ACKNOWLEDGE_REQ);
286 option.setValue(acknowledge.getValue());
287 option.setId(acknowledge.getId());
288 option.setVersionNumber(acknowledge.getVersionNumber());
289 }
290
291 public void setComplete(RuleTemplateOptionBo complete) {
292 RuleTemplateOptionBo option = getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_COMPLETE_REQ);
293 option.setValue(complete.getValue());
294 option.setId(complete.getId());
295 option.setVersionNumber(complete.getVersionNumber());
296 }
297
298 public void setApprove(RuleTemplateOptionBo approve) {
299 RuleTemplateOptionBo option = getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_APPROVE_REQ);
300 option.setValue(approve.getValue());
301 option.setId(approve.getId());
302 option.setVersionNumber(approve.getVersionNumber());
303 }
304
305 public void setFyi(RuleTemplateOptionBo fyi) {
306 RuleTemplateOptionBo option = getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_FYI_REQ);
307 option.setValue(fyi.getValue());
308 option.setId(fyi.getId());
309 option.setVersionNumber(fyi.getVersionNumber());
310 }
311
312 public void setDefaultActionRequestValue(RuleTemplateOptionBo defaultActionRequestValue) {
313 RuleTemplateOptionBo option = getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_DEFAULT_CD);
314 option.setValue(defaultActionRequestValue.getValue());
315 option.setId(defaultActionRequestValue.getId());
316 option.setVersionNumber(defaultActionRequestValue.getVersionNumber());
317 }
318
319 public RuleTemplateOptionBo getAcknowledge() {
320 return getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_ACKNOWLEDGE_REQ);
321 }
322
323 public RuleTemplateOptionBo getComplete() {
324 return getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_COMPLETE_REQ);
325 }
326
327 public RuleTemplateOptionBo getApprove() {
328 return getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_APPROVE_REQ);
329 }
330
331 public RuleTemplateOptionBo getFyi() {
332 return getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_FYI_REQ);
333 }
334
335 public RuleTemplateOptionBo getDefaultActionRequestValue() {
336 return getRuleTemplateOption(KewApiConstants.ACTION_REQUEST_DEFAULT_CD);
337 }
338
339
340
341
342
343
344 public List<RoleName> getRoles() {
345 List<RoleName> roleNames = new ArrayList<RoleName>();
346 List<RuleTemplateAttributeBo> templateAttributes = getRuleTemplateAttributes();
347 for (RuleTemplateAttributeBo templateAttribute : templateAttributes) {
348 if (!templateAttribute.isWorkflowAttribute())
349 {
350 continue;
351 }
352 roleNames.addAll(KEWServiceLocator.getWorkflowRuleAttributeMediator().getRoleNames(templateAttribute));
353 }
354 return roleNames;
355 }
356
357 public static RuleTemplate to(RuleTemplateBo bo) {
358 if (bo == null) {
359 return null;
360 }
361 return RuleTemplate.Builder.create(bo).build();
362 }
363 }