001 /**
002 * Copyright 2005-2013 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package org.kuali.rice.kew.api.rule;
017
018 import java.io.Serializable;
019 import java.util.Collection;
020 import javax.xml.bind.annotation.XmlAccessType;
021 import javax.xml.bind.annotation.XmlAccessorType;
022 import javax.xml.bind.annotation.XmlAnyElement;
023 import javax.xml.bind.annotation.XmlElement;
024 import javax.xml.bind.annotation.XmlRootElement;
025 import javax.xml.bind.annotation.XmlType;
026 import org.kuali.rice.core.api.CoreConstants;
027 import org.kuali.rice.core.api.mo.AbstractDataTransferObject;
028 import org.kuali.rice.core.api.mo.ModelBuilder;
029 import org.w3c.dom.Element;
030
031 @XmlRootElement(name = RuleExpression.Constants.ROOT_ELEMENT_NAME)
032 @XmlAccessorType(XmlAccessType.NONE)
033 @XmlType(name = RuleExpression.Constants.TYPE_NAME, propOrder = {
034 RuleExpression.Elements.TYPE,
035 RuleExpression.Elements.EXPRESSION,
036 RuleExpression.Elements.ID,
037 CoreConstants.CommonElements.VERSION_NUMBER,
038 CoreConstants.CommonElements.OBJECT_ID,
039 CoreConstants.CommonElements.FUTURE_ELEMENTS
040 })
041 public final class RuleExpression
042 extends AbstractDataTransferObject
043 implements RuleExpressionContract
044 {
045
046 @XmlElement(name = Elements.TYPE, required = false)
047 private final String type;
048 @XmlElement(name = Elements.EXPRESSION, required = false)
049 private final String expression;
050 @XmlElement(name = Elements.ID, required = false)
051 private final String id;
052 @XmlElement(name = CoreConstants.CommonElements.VERSION_NUMBER, required = false)
053 private final Long versionNumber;
054 @XmlElement(name = CoreConstants.CommonElements.OBJECT_ID, required = false)
055 private final String objectId;
056 @SuppressWarnings("unused")
057 @XmlAnyElement
058 private final Collection<Element> _futureElements = null;
059
060 /**
061 * Private constructor used only by JAXB.
062 *
063 */
064 private RuleExpression() {
065 this.type = null;
066 this.expression = null;
067 this.id = null;
068 this.versionNumber = null;
069 this.objectId = null;
070 }
071
072 private RuleExpression(Builder builder) {
073 this.type = builder.getType();
074 this.expression = builder.getExpression();
075 this.id = builder.getId();
076 this.versionNumber = builder.getVersionNumber();
077 this.objectId = builder.getObjectId();
078 }
079
080 @Override
081 public String getType() {
082 return this.type;
083 }
084
085 @Override
086 public String getExpression() {
087 return this.expression;
088 }
089
090 @Override
091 public String getId() {
092 return this.id;
093 }
094
095 @Override
096 public Long getVersionNumber() {
097 return this.versionNumber;
098 }
099
100 @Override
101 public String getObjectId() {
102 return this.objectId;
103 }
104
105
106 /**
107 * A builder which can be used to construct {@link RuleExpression} instances. Enforces the constraints of the {@link RuleExpressionContract}.
108 *
109 */
110 public final static class Builder
111 implements Serializable, ModelBuilder, RuleExpressionContract
112 {
113
114 private String type;
115 private String expression;
116 private String id;
117 private Long versionNumber;
118 private String objectId;
119
120 private Builder() {
121 // TODO modify this constructor as needed to pass any required values and invoke the appropriate 'setter' methods
122 }
123
124 public static Builder create() {
125 // TODO modify as needed to pass any required values and add them to the signature of the 'create' method
126 return new Builder();
127 }
128
129 public static Builder create(RuleExpressionContract contract) {
130 if (contract == null) {
131 throw new IllegalArgumentException("contract was null");
132 }
133 // TODO if create() is modified to accept required parameters, this will need to be modified
134 Builder builder = create();
135 builder.setType(contract.getType());
136 builder.setExpression(contract.getExpression());
137 builder.setId(contract.getId());
138 builder.setVersionNumber(contract.getVersionNumber());
139 builder.setObjectId(contract.getObjectId());
140 return builder;
141 }
142
143 public RuleExpression build() {
144 return new RuleExpression(this);
145 }
146
147 @Override
148 public String getType() {
149 return this.type;
150 }
151
152 @Override
153 public String getExpression() {
154 return this.expression;
155 }
156
157 @Override
158 public String getId() {
159 return this.id;
160 }
161
162 @Override
163 public Long getVersionNumber() {
164 return this.versionNumber;
165 }
166
167 @Override
168 public String getObjectId() {
169 return this.objectId;
170 }
171
172 public void setType(String type) {
173 // TODO add validation of input value if required and throw IllegalArgumentException if needed
174 this.type = type;
175 }
176
177 public void setExpression(String expression) {
178 // TODO add validation of input value if required and throw IllegalArgumentException if needed
179 this.expression = expression;
180 }
181
182 public void setId(String id) {
183 // TODO add validation of input value if required and throw IllegalArgumentException if needed
184 this.id = id;
185 }
186
187 public void setVersionNumber(Long versionNumber) {
188 // TODO add validation of input value if required and throw IllegalArgumentException if needed
189 this.versionNumber = versionNumber;
190 }
191
192 public void setObjectId(String objectId) {
193 // TODO add validation of input value if required and throw IllegalArgumentException if needed
194 this.objectId = objectId;
195 }
196
197 }
198
199
200 /**
201 * Defines some internal constants used on this class.
202 *
203 */
204 static class Constants {
205
206 final static String ROOT_ELEMENT_NAME = "ruleExpression";
207 final static String TYPE_NAME = "RuleExpressionType";
208
209 }
210
211
212 /**
213 * A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.
214 *
215 */
216 static class Elements {
217
218 final static String TYPE = "type";
219 final static String EXPRESSION = "expression";
220 final static String ID = "id";
221
222 }
223
224 }