fr.paris.lutece.plugins.form.business
Class Form

java.lang.Object
  extended by fr.paris.lutece.plugins.form.business.Form
All Implemented Interfaces:
fr.paris.lutece.portal.service.rbac.RBACResource, fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource

public class Form
extends java.lang.Object
implements fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource, fr.paris.lutece.portal.service.rbac.RBACResource

Class form


Field Summary
static java.lang.String RESOURCE_TYPE
           
static int STATE_DISABLE
           
static int STATE_ENABLE
           
 
Constructor Summary
Form()
           
 
Method Summary
 java.util.List<FormAction> getActions()
           
 Category getCategory()
           
 java.lang.String getCodeTheme()
           
 java.util.Date getDateBeginDisponibility()
          Return the date begin of the publication
 java.sql.Timestamp getDateCreation()
           
 java.util.Date getDateEndDisponibility()
           
 java.lang.String getDescription()
           
 int getFormPageId()
           
 int getIdForm()
           
 int getIdMailingList()
           
 java.lang.String getInfoComplementary1()
           
 java.lang.String getInfoComplementary2()
           
 java.lang.String getInfoComplementary3()
           
 java.lang.String getInfoComplementary4()
           
 java.lang.String getInfoComplementary5()
           
 java.lang.String getLibelleResetButton()
          The label to display for the Reset button
 java.lang.String getLibelleValidateButton()
           
 Recap getRecap()
           
 java.lang.String getRequirement()
           
 java.lang.String getResourceId()
          RBAC resource implmentation
 java.lang.String getResourceTypeCode()
          RBAC resource implmentation
 java.lang.String getTitle()
           
 java.lang.String getUnavailabilityMessage()
           
 java.lang.String getWelcomeMessage()
           
 java.lang.String getWorkgroup()
           
static void init()
          Initialize the Form
 boolean isActive()
           
 boolean isActiveCaptcha()
           
 boolean isActiveMyLuteceAuthentification()
           
 boolean isActiveRequirement()
           
 boolean isActiveStoreAdresse()
          true if the ip adresse of the user must be store
 boolean isAutoPublicationActive()
          Return true if auto publication is effectively active
 boolean isAutoPublished()
          Return true if the form is in auto publication mode, false else
 boolean isLimitNumberResponse()
           
 boolean isSupportHTTPS()
          Returns true if the form support HTTPS, false otherwise
 void setActions(java.util.List<FormAction> formActions)
          set a list of action can be use for the form
 void setActive(boolean active)
          set true if the form is active
 void setActiveCaptcha(boolean activeCaptcha)
          set true if the form contain a captcha
 void setActiveMyLuteceAuthentification(boolean bActiveMyLuteceAuthentification)
          set true if the form require mylutece authentification
 void setActiveRequirement(boolean activeRequirement)
          set true if the requirement must be activate
 void setActiveStoreAdresse(boolean activeStoreAdrese)
          set true if the ip adresse of the user must be store
 void setAutoPublicationActive(boolean _bAutoPublicationActive)
          Set if Auto publication is effectively active
 void setCategory(Category category)
          set the category associate to the form
 void setCodeTheme(java.lang.String strCodeTheme)
          set the theme code
 void setDateBeginDisponibility(java.util.Date _tDateBeginDisponibility)
          Define the date begin of the publication
 void setDateCreation(java.sql.Timestamp dateCreation)
          set the creation date
 void setDateEndDisponibility(java.util.Date dateEndDisponibility)
          set the date of end disponibility
 void setDescription(java.lang.String description)
          set the description of the form
 void setFormPageId(int formPageId)
          set the id of the page which contain the form
 void setIdForm(int idForm)
          set the id of the form
 void setIdMailingList(int mailingListId)
          set the id of the mailing list associate to the form
 void setInfoComplementary1(java.lang.String strInfoComplementary1)
          set the Information Complementary 1
 void setInfoComplementary2(java.lang.String strInfoComplementary2)
          set the Information Complementary 2
 void setInfoComplementary3(java.lang.String strInfoComplementary3)
          set the Information Complementary 3
 void setInfoComplementary4(java.lang.String strInfoComplementary4)
          set the Information Complementary 4
 void setInfoComplementary5(java.lang.String strInfoComplementary5)
          set the Information Complementary 5
 void setLibelleResetButton(java.lang.String _strLibelleResetButton)
          The label to display for the Reset button
 void setLibelleValidateButton(java.lang.String libelleValidateButton)
          set the libelle of the validate button
 void setLimitNumberResponse(boolean numberResponse)
          set true if the user can submit just one form
 void setRecap(Recap recap)
          set the recap associate to the form
 void setRequirement(java.lang.String requirement)
          set the requirement of the form
 void setSupportHTTPS(boolean bSupportHTTPS)
          Set to true if the form support HTTPS, false otherwise
 void setTitle(java.lang.String strTitle)
          set the title of the form
 void setUnavailabilityMessage(java.lang.String unavailabilityMessage)
          set the unavailability message of the form
 void setWelcomeMessage(java.lang.String strWelcomeMessage)
          set the welcome message of the form
 void setWorkgroup(java.lang.String workGroup)
          set the work group associate to the form
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCE_TYPE

public static final java.lang.String RESOURCE_TYPE
See Also:
Constant Field Values

STATE_ENABLE

public static final int STATE_ENABLE
See Also:
Constant Field Values

STATE_DISABLE

public static final int STATE_DISABLE
See Also:
Constant Field Values
Constructor Detail

Form

public Form()
Method Detail

init

public static void init()
Initialize the Form


getIdMailingList

public int getIdMailingList()
Returns:
the id of the mailing list associate to the form

setIdMailingList

public void setIdMailingList(int mailingListId)
set the id of the mailing list associate to the form

Parameters:
mailingListId - the id of the mailing list associate to the form

getCodeTheme

public java.lang.String getCodeTheme()
Returns:
the theme code

setCodeTheme

public void setCodeTheme(java.lang.String strCodeTheme)
set the theme code

Parameters:
strCodeTheme - the theme code

isActiveCaptcha

public boolean isActiveCaptcha()
Returns:
true if the form contain a captcha

setActiveCaptcha

public void setActiveCaptcha(boolean activeCaptcha)
set true if the form contain a captcha

Parameters:
activeCaptcha - true if the form contain a captcha

isActiveStoreAdresse

public boolean isActiveStoreAdresse()
true if the ip adresse of the user must be store

Returns:
true if the ip adresse of the user must be store

setActiveStoreAdresse

public void setActiveStoreAdresse(boolean activeStoreAdrese)
set true if the ip adresse of the user must be store

Parameters:
activeStoreAdrese - true if the ip adresse of the user must be store

isActiveRequirement

public boolean isActiveRequirement()
Returns:
true if the requirement must be activate

setActiveRequirement

public void setActiveRequirement(boolean activeRequirement)
set true if the requirement must be activate

Parameters:
activeRequirement - true if the form contain requirement

getLibelleValidateButton

public java.lang.String getLibelleValidateButton()
Returns:
the libelle of the validate button

setLibelleValidateButton

public void setLibelleValidateButton(java.lang.String libelleValidateButton)
set the libelle of the validate button

Parameters:
libelleValidateButton - the libelle of the validate button

getDateEndDisponibility

public java.util.Date getDateEndDisponibility()
Returns:
the date of end diosponibility

setDateEndDisponibility

public void setDateEndDisponibility(java.util.Date dateEndDisponibility)
set the date of end disponibility

Parameters:
dateEndDisponibility - the date of end disponibility

getRequirement

public java.lang.String getRequirement()
Returns:
the requirement of the form

setRequirement

public void setRequirement(java.lang.String requirement)
set the requirement of the form

Parameters:
requirement - the requierement of the form

getTitle

public java.lang.String getTitle()
Returns:
the title of the form

setTitle

public void setTitle(java.lang.String strTitle)
set the title of the form

Parameters:
strTitle - the title of the form

getDescription

public java.lang.String getDescription()
Returns:
the description of the form

setDescription

public void setDescription(java.lang.String description)
set the description of the form

Parameters:
description - the description of the form

getWelcomeMessage

public java.lang.String getWelcomeMessage()
Returns:
the welcome message of the form

setWelcomeMessage

public void setWelcomeMessage(java.lang.String strWelcomeMessage)
set the welcome message of the form

Parameters:
strWelcomeMessage - the welcome message of the form

getUnavailabilityMessage

public java.lang.String getUnavailabilityMessage()
Returns:
the unavailability message of the form

setUnavailabilityMessage

public void setUnavailabilityMessage(java.lang.String unavailabilityMessage)
set the unavailability message of the form

Parameters:
unavailabilityMessage - the unavailability message of the form

getWorkgroup

public java.lang.String getWorkgroup()
Specified by:
getWorkgroup in interface fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource
Returns:
the work group associate to the form

setWorkgroup

public void setWorkgroup(java.lang.String workGroup)
set the work group associate to the form

Parameters:
workGroup - the work group associate to the form

getIdForm

public int getIdForm()
Returns:
the id of the form

setIdForm

public void setIdForm(int idForm)
set the id of the form

Parameters:
idForm - the id of the form

isActive

public boolean isActive()
Returns:
true if the form is active

setActive

public void setActive(boolean active)
set true if the form is active

Parameters:
active - true if the form is active

isLimitNumberResponse

public boolean isLimitNumberResponse()
Returns:
true if the user can submit just one form

setLimitNumberResponse

public void setLimitNumberResponse(boolean numberResponse)
set true if the user can submit just one form

Parameters:
numberResponse - true if the user can submit just one form

getDateCreation

public java.sql.Timestamp getDateCreation()
Returns:
the creation date

setDateCreation

public void setDateCreation(java.sql.Timestamp dateCreation)
set the creation date

Parameters:
dateCreation - the creation date

getRecap

public Recap getRecap()
Returns:
the recap associate to the form

setRecap

public void setRecap(Recap recap)
set the recap associate to the form

Parameters:
recap - the recap associate to the form

getResourceTypeCode

public java.lang.String getResourceTypeCode()
RBAC resource implmentation

Specified by:
getResourceTypeCode in interface fr.paris.lutece.portal.service.rbac.RBACResource
Returns:
The resource type code

getResourceId

public java.lang.String getResourceId()
RBAC resource implmentation

Specified by:
getResourceId in interface fr.paris.lutece.portal.service.rbac.RBACResource
Returns:
The resourceId

getActions

public java.util.List<FormAction> getActions()
Returns:
a list of action can be use for the form

setActions

public void setActions(java.util.List<FormAction> formActions)
set a list of action can be use for the form

Parameters:
formActions - a list of action must be use for the form

getFormPageId

public int getFormPageId()
Returns:
the id of the page which contain the form

setFormPageId

public void setFormPageId(int formPageId)
set the id of the page which contain the form

Parameters:
formPageId - the id of the page which contain the form

setDateBeginDisponibility

public void setDateBeginDisponibility(java.util.Date _tDateBeginDisponibility)
Define the date begin of the publication

Parameters:
_tDateBeginDisponibility - The date begin of the publication

getDateBeginDisponibility

public java.util.Date getDateBeginDisponibility()
Return the date begin of the publication

Returns:
The date begin of the publication

setAutoPublicationActive

public void setAutoPublicationActive(boolean _bAutoPublicationActive)
Set if Auto publication is effectively active

Parameters:
_bAutoPublicationActive -

isAutoPublicationActive

public boolean isAutoPublicationActive()
Return true if auto publication is effectively active

Returns:
true of false

isAutoPublished

public boolean isAutoPublished()
Return true if the form is in auto publication mode, false else

Returns:
true if the form is auto published

setLibelleResetButton

public void setLibelleResetButton(java.lang.String _strLibelleResetButton)
The label to display for the Reset button

Parameters:
_strLibelleResetButton - The label

getLibelleResetButton

public java.lang.String getLibelleResetButton()
The label to display for the Reset button

Returns:
the Reset button name

getInfoComplementary1

public java.lang.String getInfoComplementary1()
Returns:
the Information Complementary 1

setInfoComplementary1

public void setInfoComplementary1(java.lang.String strInfoComplementary1)
set the Information Complementary 1

Parameters:
strInfoComplementary1 - the Information Complementary 1

getInfoComplementary2

public java.lang.String getInfoComplementary2()
Returns:
the Information Complementary 1

setInfoComplementary2

public void setInfoComplementary2(java.lang.String strInfoComplementary2)
set the Information Complementary 2

Parameters:
strInfoComplementary2 - the Information Complementary 2

getInfoComplementary3

public java.lang.String getInfoComplementary3()
Returns:
the Information Complementary 3

setInfoComplementary3

public void setInfoComplementary3(java.lang.String strInfoComplementary3)
set the Information Complementary 3

Parameters:
strInfoComplementary3 - the Information Complementary 3

getInfoComplementary4

public java.lang.String getInfoComplementary4()
Returns:
the Information Complementary 4

setInfoComplementary4

public void setInfoComplementary4(java.lang.String strInfoComplementary4)
set the Information Complementary 4

Parameters:
strInfoComplementary4 - the Information Complementary 4

getInfoComplementary5

public java.lang.String getInfoComplementary5()
Returns:
the Information Complementary 5

setInfoComplementary5

public void setInfoComplementary5(java.lang.String strInfoComplementary5)
set the Information Complementary 5

Parameters:
strInfoComplementary5 - the Information Complementary 5

setSupportHTTPS

public void setSupportHTTPS(boolean bSupportHTTPS)
Set to true if the form support HTTPS, false otherwise

Parameters:
_bSupportHTTPS - the support value

isSupportHTTPS

public boolean isSupportHTTPS()
Returns true if the form support HTTPS, false otherwise

Returns:
true if the form support HTTPS, false otherwise

isActiveMyLuteceAuthentification

public boolean isActiveMyLuteceAuthentification()
Returns:
true if the form require mylutece authentification

setActiveMyLuteceAuthentification

public void setActiveMyLuteceAuthentification(boolean bActiveMyLuteceAuthentification)
set true if the form require mylutece authentification

Parameters:
active - true if the form require mylutece authentification

getCategory

public Category getCategory()
Returns:
the category associate to the form

setCategory

public void setCategory(Category category)
set the category associate to the form

Parameters:
category - the category associate to the form


Copyright © 2012 Mairie de Paris. All Rights Reserved.