001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.gwt.shared;
029
030import com.google.gwt.user.client.rpc.IsSerializable;
031
032/**
033 * This class represents the result of a "return link" lookup, which is what happens if the user
034 * clicks the "go to last page" button in the sitemap editor. It contains a link string (possibly null)
035 * and a status to indicate possible errors.<p>
036 *
037 * @since 8.0.0
038 */
039public class CmsReturnLinkInfo implements IsSerializable {
040
041    /**
042     * The moved status.<p>
043     */
044    public enum Status {
045        /** The link was successfully looked up. */
046        ok, /** The resource(s) was not found. */
047        notfound
048    }
049
050    /** The return link (null if not found). */
051    private String m_link;
052
053    /** The status of the lookup operation. */
054    private Status m_status;
055
056    /**
057     * Creates a new instance.<p>
058     *
059     * @param link the return link
060     * @param status the link lookup status
061     */
062    public CmsReturnLinkInfo(String link, Status status) {
063
064        m_link = link;
065        m_status = status;
066    }
067
068    /**
069     * Protected default constructor for serialization.<p>
070     */
071    protected CmsReturnLinkInfo() {
072
073        // do nothing
074    }
075
076    /**
077     * Returns the return link.<p>
078     *
079     * @return the return link
080     */
081    public String getLink() {
082
083        return m_link;
084    }
085
086    /**
087     * Returns the link lookup status.<p>
088     *
089     * @return the link lookup status
090     */
091    public Status getStatus() {
092
093        return m_status;
094    }
095
096}