View Javadoc

1   /**
2    * Copyright 2005-2013 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.datadictionary;
17  
18  import org.kuali.rice.krad.datadictionary.parse.BeanTag;
19  import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
20  import org.kuali.rice.krad.util.documentserializer.PropertySerializabilityEvaluator;
21  
22  import java.io.Serializable;
23  
24  /**
25   * This class represents an serializable property when generating workflow routing XML.  The path contained within this
26   * object
27   * is relative to the basePath in the {@link WorkflowPropertyGroup} that contains this object.  The semantics of the
28   * path are determined
29   * by the {@link PropertySerializabilityEvaluator} that evaluates whether a property is serializable.
30   */
31  @BeanTag(name = "workflowProperty-bean")
32  public class WorkflowProperty implements Serializable {
33      private static final long serialVersionUID = 1L;
34  
35      protected String path = null;
36  
37      /**
38       * Default constructor, sets path to null
39       */
40      public WorkflowProperty() {}
41  
42      /**
43       * Returns the path to the property that is serializable, relative to the {@link WorkflowPropertyGroup} that
44       * contains this object
45       *
46       * @return
47       */
48      @BeanTagAttribute(name = "path")
49      public String getPath() {
50          return this.path;
51      }
52  
53      /**
54       * Sets the path to the property that is serializable, relative to the {@link WorkflowPropertyGroup} that contains
55       * this object
56       *
57       * @param path
58       */
59      public void setPath(String path) {
60          this.path = path;
61      }
62  }