PageIncludeEntry.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.service.includes;

import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.portal.service.plugin.PluginService;

/**
 * PageInclude Entry used by XML plugin file
 */
public class PageIncludeEntry
{
    // Variables declarations
    private String _strId;
    private String _strClassName;
    private String _strPluginName;
    private boolean _bEnabled = true; // defaults to enabled
    private PageInclude _pageInclude;

    /**
     * Returns the Id
     *
     * @return The Id
     */
    public String getId( )
    {
        return _strId;
    }

    /**
     * Sets the Id
     *
     * @param strId
     *            The Id
     */
    public void setId( String strId )
    {
        _strId = strId;
    }

    /**
     * Returns the ClassName
     *
     * @return The ClassName
     */
    public String getClassName( )
    {
        return _strClassName;
    }

    /**
     * Sets the ClassName
     *
     * @param strClassName
     *            The ClassName
     */
    public void setClassName( String strClassName )
    {
        _strClassName = strClassName;
    }

    /**
     * Return the name of the plugin
     *
     * @return The name of the plugin
     */
    public String getPluginName( )
    {
        return _strPluginName;
    }

    /**
     * Set the plugin name
     *
     * @param strPluginName
     *            the plugin name
     */
    public void setPluginName( String strPluginName )
    {
        _strPluginName = strPluginName;
    }

    /**
     * Sets the enabled state of this PageInclude
     * 
     * @param enabled
     *            <code>true</code> if this PageInclude is enabled, <code>false</code> otherwise
     * @since 5.1
     */
    public void setEnabled( boolean enabled )
    {
        _bEnabled = enabled;
    }

    /**
     * Tells if the PageInclude is enabled, independently of the plugin's status
     * 
     * @return <code>true</code> if this PageInclude is enabled, <code>false</code> otherwise
     * @since 5.1
     */
    public boolean isEnabled( )
    {
        return _bEnabled;
    }

    /**
     * Tells if the PageInclude is enabled (plugin enabled and this particular PageInclude is enabled)
     *
     * @return True if the PageInclude is enabled, otherwise false
     */
    public boolean isEnable( )
    {
        return PluginService.isPluginEnable( _strPluginName ) && _bEnabled;
    }

    /**
     * Gets the plugin instance associated to the application
     *
     * @return the plugin
     */
    public Plugin getPlugin( )
    {
        return PluginService.getPlugin( _strPluginName );
    }

    /**
     * Sets the PageInclude object
     * 
     * @param pageInclude
     *            the PageInclude object
     */
    public void setPageInclude( PageInclude pageInclude )
    {
        _pageInclude = pageInclude;
    }

    /**
     * Gets the PageInclude object
     * 
     * @return The PageInclude object
     */
    public PageInclude getPageInclude( )
    {
        return _pageInclude;
    }
}