View Javadoc
1   /**
2    * Copyright 2005-2014 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.uif.view;
17  
18  import org.apache.commons.lang.StringUtils;
19  import org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase;
20  import org.kuali.rice.krad.datadictionary.parse.BeanTag;
21  import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
22  
23  import java.io.Serializable;
24  
25  /**
26   * A simple object that keeps track of various HistoryInformation
27   *
28   * TODO a variety of these settings are not used in the current implementation of breadcrumbs
29   * and history, they may be removed later if they prove unuseful in future changes
30   *
31   * @author Kuali Rice Team (rice.collab@kuali.org)
32   */
33  @BeanTag(name = "historyEntry", parent = "Uif-HistoryEntry")
34  public class HistoryEntry extends UifDictionaryBeanBase implements Serializable {
35      private static final long serialVersionUID = -8310916657379268794L;
36  
37      private String viewId;
38      private String pageId;
39      private String title;
40      private String url;
41      private String formKey;
42  
43      public HistoryEntry() {
44          super();
45      }
46  
47      public HistoryEntry(String viewId, String pageId, String title, String url, String formKey) {
48          super();
49  
50          this.viewId = viewId;
51          this.pageId = pageId;
52          this.title = title;
53          this.url = url;
54          this.formKey = formKey;
55      }
56  
57      /**
58       * The viewId of the view
59       *
60       * @return the viewId
61       */
62      @BeanTagAttribute
63      public String getViewId() {
64          return this.viewId;
65      }
66  
67      /**
68       * @param viewId the viewId to set
69       */
70      public void setViewId(String viewId) {
71          this.viewId = viewId;
72      }
73  
74      /**
75       * The pageId of the page on the view
76       *
77       * @return the pageId
78       */
79      @BeanTagAttribute
80      public String getPageId() {
81          return this.pageId;
82      }
83  
84      /**
85       * @param pageId the pageId to set
86       */
87      public void setPageId(String pageId) {
88          this.pageId = pageId;
89      }
90  
91      /**
92       * The title of the view
93       *
94       * @return the title
95       */
96      @BeanTagAttribute
97      public String getTitle() {
98          return this.title;
99      }
100 
101     /**
102      * @param title the title to set
103      */
104     public void setTitle(String title) {
105         this.title = title;
106     }
107 
108     /**
109      * The url of this HistoryEntry
110      *
111      * @return the url
112      */
113     @BeanTagAttribute
114     public String getUrl() {
115         return this.url;
116     }
117 
118     /**
119      * @param url the url to set
120      */
121     public void setUrl(String url) {
122         this.url = url;
123     }
124 
125     /**
126      * @return the formKey
127      */
128     @BeanTagAttribute
129     public String getFormKey() {
130         return this.formKey;
131     }
132 
133     /**
134      * The formKey of the form in the view
135      *
136      * @param formKey the formKey to set
137      */
138     public void setFormKey(String formKey) {
139         this.formKey = formKey;
140     }
141 
142 }