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