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