/*
    * Copyright (c) 2002-2017, Mairie de 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.directory.business;
  
  import fr.paris.lutece.portal.business.regularexpression.RegularExpression;
  import fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource;
  
  import java.util.Date;
  import java.util.List;
  
  /**
   *
   * class Field
   *
   */
  public class Field implements AdminWorkgroupResource
  {
      public static final String ATTRIBUTE_FIELD_TITLE = "title";
      public static final String ATTRIBUTE_FIELD_ID = "id";
      private int _nIdField;
      private IEntry _entry;
      private String _strTitle;
      private String _strValue;
      private int _nHeight;
      private int _nWidth;
      private int _nMaxSizeEnter;
      private int _nPosition;
      private boolean _bShownInResultList;
      private boolean _bShownInResultRecord;
      private boolean _bDefaultValue;
      private Date _tValueTypeDate;
      private List<RegularExpression> _listRegularExpressionList;
      private String _strRoleKey;
      private String _strWorkgroupKey;
      private String _strImageType;
  
      /**
       *
       * @return the id of the field
       */
      public int getIdField( )
      {
          return _nIdField;
      }
  
      /**
       * set the id of the field
       * 
       * @param idField
       *            the id of the field
       */
      public void setIdField( int idField )
      {
          _nIdField = idField;
      }
  
      /**
       *
       * @return the position of the field in the list of the entry's fields
       */
      public int getPosition( )
      {
          return _nPosition;
      }
  
      /**
       * set the position of the field in the list of the entry's fields
       * 
      * @param position
      *            the position of the field in the list of fields
      */
     public void setPosition( int position )
     {
         _nPosition = position;
     }
 
     /**
      *
      * @return the entry of the field
      */
     public IEntry getEntry( )
     {
         return _entry;
     }
 
     /**
      * set the entry of the field
      * 
      * @param entry
      *            the entry of the field
      */
     public void setEntry( IEntry entry )
     {
         _entry = entry;
     }
 
     /**
      *
      * @return a list of regular expression which is associate to the field
      */
     public List<RegularExpression> getRegularExpressionList( )
     {
         return _listRegularExpressionList;
     }
 
     /**
      * set a list of regular expression which is associate to the field
      * 
      * @param regularExpressionList
      *            a list of regular expression which is associate to the field
      */
     public void setRegularExpressionList( List<RegularExpression> regularExpressionList )
     {
         _listRegularExpressionList = regularExpressionList;
     }
 
     /**
      *
      * @return the title of the field
      */
     public String getTitle( )
     {
         return _strTitle;
     }
 
     /**
      * set the title of the field
      * 
      * @param title
      *            the title of the field
      */
     public void setTitle( String title )
     {
         _strTitle = title;
     }
 
     /**
      *
      * @return the value of the field
      */
     public String getValue( )
     {
         return _strValue;
     }
 
     /**
      * set the value of the field
      * 
      * @param value
      *            the value of the field
      */
     public void setValue( String value )
     {
         _strValue = value;
     }
 
     /**
      *
      * @return the width of the field
      */
     public int getWidth( )
     {
         return _nWidth;
     }
 
     /**
      * set the width of the field
      * 
      * @param width
      *            the width of the field
      */
     public void setWidth( int width )
     {
         this._nWidth = width;
     }
 
     /**
      *
      * @return the height of the field
      */
     public int getHeight( )
     {
         return _nHeight;
     }
 
     /**
      * set the height of the field
      * 
      * @param height
      *            the height of the field
      */
     public void setHeight( int height )
     {
         _nHeight = height;
     }
 
     /**
      *
      * @return true if the field is a default field of the entry
      */
     public boolean isDefaultValue( )
     {
         return _bDefaultValue;
     }
 
     /**
      * set true if the field is a default field of the entry
      * 
      * @param defaultValue
      *            true if the field is a default field of the entry
      */
     public void setDefaultValue( boolean defaultValue )
     {
         _bDefaultValue = defaultValue;
     }
 
     /**
      *
      * @return true if the field is shown in result list
      */
     public boolean isShownInResultList( )
     {
         return _bShownInResultList;
     }
 
     /**
      * set true if the field is shown in result list
      * 
      * @param bShown
      *            True if the field is shown in the result list, false otherwise
      */
     public void setShownInResultList( boolean bShown )
     {
         _bShownInResultList = bShown;
     }
 
     /**
      *
      * @return true if the field is shown in result record
      */
     public boolean isShownInResultRecord( )
     {
         return _bShownInResultRecord;
     }
 
     /**
      * set true if the field is shown in result record
      * 
      * @param bShown
      *            True if the field is shown in the result list, false otherwise
      */
     public void setShownInResultRecord( boolean bShown )
     {
         _bShownInResultRecord = bShown;
     }
 
     /**
      *
      * @return the max size of enter user
      */
     public int getMaxSizeEnter( )
     {
         return _nMaxSizeEnter;
     }
 
     /**
      * set the max size of enter user
      * 
      * @param maxSizeEnter
      *            the max size of enter user
      */
     public void setMaxSizeEnter( int maxSizeEnter )
     {
         _nMaxSizeEnter = maxSizeEnter;
     }
 
     /**
      *
      * @return the value of type Date
      */
     public Date getValueTypeDate( )
     {
         return _tValueTypeDate;
     }
 
     /**
      * set the value of type Date
      * 
      * @param defaultValueTypeDate
      *            the value of type Date
      */
     public void setValueTypeDate( Date defaultValueTypeDate )
     {
         _tValueTypeDate = defaultValueTypeDate;
     }
 
     /**
      * Gets the field role
      * 
      * @return field role as a String
      *
      */
     public String getRoleKey( )
     {
         return _strRoleKey;
     }
 
     /**
      * Sets the field's role
      * 
      * @param strRole
      *            The role
      *
      */
     public void setRoleKey( String strRole )
     {
         _strRoleKey = strRole;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getWorkgroup( )
     {
         return _strWorkgroupKey;
     }
 
     /**
      * set the work group associate to the field
      * 
      * @param workGroup
      *            the work group associate to the field
      */
     public void setWorkgroup( String workGroup )
     {
         _strWorkgroupKey = workGroup;
     }
 
     /**
      * Gets the field ImageType
      * 
      * @return field ImageType as a String
      *
      */
     public String getImageType( )
     {
         return _strImageType;
     }
 
     /**
      * Sets the field's ImageType
      * 
      * @param strImageType
      *            The Image Type
      *
      */
     public void setImageType( String strImageType )
     {
         _strImageType = strImageType;
     }
 }