001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (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.db;
029
030import org.opencms.util.CmsUUID;
031
032/**
033 * Filter class used for selecting rewrite aliases from the database.<p>
034 */
035public class CmsRewriteAliasFilter {
036
037    /** The id to use for filtering. */
038    private CmsUUID m_id;
039
040    /** The site root to filter with. */
041    private String m_siteRoot;
042
043    /**
044     * Gets the id to filter with.<p>
045     *
046     * @return the id to filter with
047     */
048    public CmsUUID getId() {
049
050        return m_id;
051    }
052
053    /**
054     * Gets the site root used for filtering.<p>
055     *
056     * @return the site root used for filtering
057     */
058    public String getSiteRoot() {
059
060        return m_siteRoot;
061    }
062
063    /**
064     * Sets the id of the rewrite alias we want.<p>
065     *
066     * @param id a rewrite alias id
067     *
068     * @return this filter
069     */
070    public CmsRewriteAliasFilter setId(CmsUUID id) {
071
072        m_id = id;
073        return this;
074    }
075
076    /**
077     * Sets the site root to use for filtering.<p>
078     *
079     * @param siteRoot the site root
080     *
081     * @return this filter
082     */
083    public CmsRewriteAliasFilter setSiteRoot(String siteRoot) {
084
085        m_siteRoot = siteRoot;
086        return this;
087    }
088}