IndexerActionFilter.java

/*
 * Copyright (c) 2002-2021, 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.plugins.blog.business;

/**
 *
 * class IndexerActionFilter
 *
 */
public class IndexerActionFilter
{
    /**
     * Represent any integer
     */
    public static final int ALL_INT = -1;
    private int _nIdTask = ALL_INT;
    private int _nIdBlog = ALL_INT;

    /**
     * gets the id of task
     * 
     * @return the task id insert in the filter
     */
    public int getIdTask( )
    {
        return _nIdTask;
    }

    /**
     * set the task id in the filter
     * 
     * @param idTask
     *            the task id to insert in the filter
     */
    public void setIdTask( int idTask )
    {
        _nIdTask = idTask;
    }

    /**
     * weather or not it contains the task
     * 
     * @return true if the filter contain a task id
     */
    public boolean containsIdTask( )
    {
        return ( _nIdTask != ALL_INT );
    }

    /**
     * Get the id of the blog
     * 
     * @return The id of the blog
     */
    public int getIdBlog( )
    {
        return _nIdBlog;
    }

    /**
     * Set the id of the blog
     * 
     * @param nId
     *            The id of the Blog
     */
    public void setIdBlog( int nId )
    {
        this._nIdBlog = nId;
    }

    /**
     * Check if this filter contains an Blog id
     * 
     * @return True if this filter contains an Blog id, false otherwise
     */
    public boolean containsIdBlog( )
    {
        return ( _nIdBlog != ALL_INT );
    }
}