001/**
002 * Copyright 2005-2018 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 */
016package org.kuali.rice.krad.uif.view;
017
018import org.apache.commons.lang.StringUtils;
019import org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase;
020import org.kuali.rice.krad.datadictionary.parse.BeanTag;
021import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
022
023import java.io.Serializable;
024
025/**
026 * A simple object that keeps track of various HistoryInformation
027 *
028 * TODO a variety of these settings are not used in the current implementation of breadcrumbs
029 * and history, they may be removed later if they prove unuseful in future changes
030 *
031 * @author Kuali Rice Team (rice.collab@kuali.org)
032 */
033@BeanTag(name = "historyEntry", parent = "Uif-HistoryEntry")
034public class HistoryEntry extends UifDictionaryBeanBase implements Serializable {
035    private static final long serialVersionUID = -8310916657379268794L;
036
037    private String viewId;
038    private String pageId;
039    private String title;
040    private String url;
041    private String formKey;
042
043    public HistoryEntry() {
044        super();
045    }
046
047    public HistoryEntry(String viewId, String pageId, String title, String url, String formKey) {
048        super();
049
050        this.viewId = viewId;
051        this.pageId = pageId;
052        this.title = title;
053        this.url = url;
054        this.formKey = formKey;
055    }
056
057    /**
058     * The viewId of the view
059     *
060     * @return the viewId
061     */
062    @BeanTagAttribute
063    public String getViewId() {
064        return this.viewId;
065    }
066
067    /**
068     * @param viewId the viewId to set
069     */
070    public void setViewId(String viewId) {
071        this.viewId = viewId;
072    }
073
074    /**
075     * The pageId of the page on the view
076     *
077     * @return the pageId
078     */
079    @BeanTagAttribute
080    public String getPageId() {
081        return this.pageId;
082    }
083
084    /**
085     * @param pageId the pageId to set
086     */
087    public void setPageId(String pageId) {
088        this.pageId = pageId;
089    }
090
091    /**
092     * The title of the view
093     *
094     * @return the title
095     */
096    @BeanTagAttribute
097    public String getTitle() {
098        return this.title;
099    }
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}