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.ade.configuration;
029
030import org.opencms.util.CmsUUID;
031
032/**
033 * Bean for representing a named dynamic function reference from the configuration.<p>
034 */
035public class CmsFunctionReference implements I_CmsConfigurationObject<CmsFunctionReference> {
036
037    /** The function default page id. */
038    private CmsUUID m_functionDefaultPageId;
039
040    /** The function reference name. */
041    private String m_name;
042
043    /** A number used for sorting the function references.<p>*/
044    private int m_order;
045
046    /** The function resource structure id. */
047    private CmsUUID m_structureId;
048
049    /**
050     * Creates a new function reference.<p>
051     *
052     * @param name the name of the function reference
053     * @param structureId the structure id of the function
054     * @param functionDefaultPageId the function default page id
055     * @param order the number used for sorting the function references
056     */
057    public CmsFunctionReference(String name, CmsUUID structureId, CmsUUID functionDefaultPageId, int order) {
058
059        m_name = name;
060        m_structureId = structureId;
061        m_functionDefaultPageId = functionDefaultPageId;
062        m_order = order;
063    }
064
065    /**
066     * Returns the function default page id.<p>
067     *
068     * @return the function default page id
069     */
070    public CmsUUID getFunctionDefaultPageId() {
071
072        return m_functionDefaultPageId;
073    }
074
075    /**
076     * @see org.opencms.ade.configuration.I_CmsConfigurationObject#getKey()
077     */
078    public String getKey() {
079
080        return m_name;
081    }
082
083    /**
084     * Returns the name of the function reference.<p>
085     *
086     * @return the name of the function reference
087     */
088    public String getName() {
089
090        return m_name;
091    }
092
093    /**
094     * The order information for sorting the function references.<p>
095     *
096     * @return the order information
097     */
098    public int getOrder() {
099
100        return m_order;
101    }
102
103    /**
104     * Returns the structure id of the dynamic function resource.<p>
105     *
106     * @return the structure id of the function
107     */
108    public CmsUUID getStructureId() {
109
110        return m_structureId;
111    }
112
113    /**
114     * @see org.opencms.ade.configuration.I_CmsConfigurationObject#isDisabled()
115     */
116    public boolean isDisabled() {
117
118        return false;
119    }
120
121    /**
122     * @see org.opencms.ade.configuration.I_CmsConfigurationObject#merge(org.opencms.ade.configuration.I_CmsConfigurationObject)
123     */
124    public CmsFunctionReference merge(CmsFunctionReference child) {
125
126        return child;
127    }
128}