TaskAlertConfig.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.workflow.modules.alertforms.business;

import fr.paris.lutece.plugins.forms.business.FormResponse;
import fr.paris.lutece.plugins.workflow.modules.alertforms.business.retrieval.IRetrievalType;
import fr.paris.lutece.plugins.workflow.modules.alertforms.business.retrieval.RetrievalTypeFactory;
import fr.paris.lutece.plugins.workflow.modules.alertforms.util.annotation.AlertConfig;
import fr.paris.lutece.plugins.workflowcore.business.config.TaskConfig;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

/**
 *
 * TaskAlertConfig
 *
 */
@AlertConfig
public class TaskAlertConfig extends TaskConfig
{
    @NotNull
    @Min( 1 )
    private int _nIdForm;
    @NotNull
    @Min( 1 )
    private int _nIdStateAfterDeadline;
    private int _nIdQuestionDate;
    @NotNull
    private int _nNbDaysToDate;
    @NotNull
    @Min( 1 )
    private int _nIdRetrievalType;

    /**
     * Set the id form
     * 
     * @param nIdForm
     *            the id form
     */
    public void setIdForm( int nIdForm )
    {
        _nIdForm = nIdForm;
    }

    /**
     * Get the id of the form
     * 
     * @return the id form
     */
    public int getIdForm( )
    {
        return _nIdForm;
    }

    /**
     * Set the id state after deadline
     * 
     * @param nIdStateAfterDeadline
     *            the id state after deadline
     */
    public void setIdStateAfterDeadline( int nIdStateAfterDeadline )
    {
        _nIdStateAfterDeadline = nIdStateAfterDeadline;
    }

    /**
     * Get the id state after deadline
     * 
     * @return the id state after deadline
     */
    public int getIdStateAfterDeadline( )
    {
        return _nIdStateAfterDeadline;
    }

    /**
     * Set the id of the question for the date
     * 
     * @param nIdQuestionDate
     */
    public void setIdQuestionDate( int nIdQuestionDate )
    {
        _nIdQuestionDate = nIdQuestionDate;
    }

    /**
     * Get the question for the date
     * 
     * @return the position
     */
    public int getIdQuestionDate( )
    {
        return _nIdQuestionDate;
    }

    /**
     * Set the number of days to date
     * 
     * @param nNbDaysToDate
     *            the number of days
     */
    public void setNbDaysToDate( int nNbDaysToDate )
    {
        _nNbDaysToDate = nNbDaysToDate;
    }

    /**
     * Get the number of days
     * 
     * @return the number of days
     */
    public int getNbDaysToDate( )
    {
        return _nNbDaysToDate;
    }

    /**
     * Set the id retrieval type
     * 
     * @param nIdRetrievalType
     *            the id retrieval type
     */
    public void setIdRetrievalType( int nIdRetrievalType )
    {
        _nIdRetrievalType = nIdRetrievalType;
    }

    /**
     * Get the id retrieval type
     * 
     * @return the id retrieval type
     */
    public int getIdRetrievalType( )
    {
        return _nIdRetrievalType;
    }

    /**
     * Get the retrieval type
     * 
     * @param formResponse
     *            the formResponse
     * @return the retrieval type
     */
    public Long getDate( FormResponse formResponse )
    {
        IRetrievalType retrievalType = RetrievalTypeFactory.getRetrievalType( _nIdRetrievalType );

        if ( retrievalType != null )
        {
            return retrievalType.getDate( this, formResponse );
        }

        return null;
    }
}