public class Form extends Object implements fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource, fr.paris.lutece.portal.service.rbac.RBACResource
Modifier and Type | Field and Description |
---|---|
static String |
RESOURCE_TYPE
Form resource type
|
static String |
ROLE_NONE |
static int |
STATE_DISABLE
State of forms that are disabled
|
static int |
STATE_ENABLE
State of forms that are enabled
|
Constructor and Description |
---|
Form() |
Modifier and Type | Method and Description |
---|---|
List<FormAction> |
getActions() |
boolean |
getAutomaticCleaning()
Check if this form should be cleaned automatically by the daemon
|
Category |
getCategory()
Get the category associate to the form
|
boolean |
getCleaningByRemoval()
Check if the cleaning operation is a remove operation or an anonymization
operation
|
String |
getCodeTheme()
Get the code theme
|
Date |
getDateBeginDisponibility()
Return the date begin of the publication
|
Timestamp |
getDateCreation()
Get the creation date
|
Date |
getDateEndDisponibility()
Get the date of end of disponibility
|
String |
getDescription()
Get the description of the form
|
int |
getFormPageId()
Get the recap associate to the form
|
String |
getFrontOfficeTitle()
gets the front office's title
|
int |
getIdForm()
Get the id of the form
|
int |
getIdMailingList()
Get the id of the mailing list associate to the form
|
String |
getInfoComplementary1()
Get the Information Complementary 1
|
String |
getInfoComplementary2()
Get the Information Complementary 2
|
String |
getInfoComplementary3()
Get the Information Complementary 3
|
String |
getInfoComplementary4()
Get the Information Complementary 4
|
String |
getInfoComplementary5()
Get the Information Complementary 5
|
String |
getLibelleResetButton()
The label to display for the Reset button
|
String |
getLibelleValidateButton()
Get the label of the validate button
|
int |
getNbDaysBeforeCleaning()
Get the number of days to keep responses before cleaning them
|
Recap |
getRecap()
Get the recap associated to the form
|
String |
getRequirement()
Get the requirement of the form
|
String |
getResourceId() |
String |
getResourceTypeCode() |
String |
getTitle()
Get the title of the form
|
String |
getUnavailabilityMessage()
Get the unavailability message of the form
|
String |
getWelcomeMessage()
Get the welcome message of the form
|
String |
getWorkgroup() |
static void |
init()
Initialize the Form
|
boolean |
isActive()
Check if the form is active or not
|
boolean |
isActiveCaptcha()
Check if the form contain a captcha
|
boolean |
isActiveMyLuteceAuthentification()
Check if the form require mylutece authentication
|
boolean |
isActiveRequirement()
Check if the requirement must be activate
|
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()
Check the user can only submit one form, or if he can submit several
|
boolean |
isShownFrontOfficeTitle()
get the value of the boolean isShownFrontOfficeTitle
|
boolean |
isSupportHTTPS()
Returns true if the form support HTTPS, false otherwise
|
void |
setActions(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 authentication
|
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 |
setAutomaticCleaning(boolean bAutomaticCleaning)
Set if this form should be cleaned automatically by the daemon
|
void |
setAutoPublicationActive(boolean bAutoPublicationActive)
Set if Auto publication is effectively active
|
void |
setCategory(Category category)
set the category associate to the form
|
void |
setCleaningByRemoval(boolean bCleaningByRemoval)
Set the cleaning operation a a remove operation or as an anonymization
operation
|
void |
setCodeTheme(String strCodeTheme)
set the theme code
|
void |
setDateBeginDisponibility(Date tDateBeginDisponibility)
Define the date begin of the publication
|
void |
setDateCreation(Timestamp dateCreation)
set the creation date
|
void |
setDateEndDisponibility(Date dateEndDisponibility)
set the date of end of disponibility
|
void |
setDescription(String description)
set the description of the form
|
void |
setFormPageId(int formPageId)
set the id of the page which contain the form
|
void |
setFrontOfficeTitle(String strFrontOfficeTitle)
Set the front office's title
|
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(String strInfoComplementary1)
set the Information Complementary 1
|
void |
setInfoComplementary2(String strInfoComplementary2)
set the Information Complementary 2
|
void |
setInfoComplementary3(String strInfoComplementary3)
set the Information Complementary 3
|
void |
setInfoComplementary4(String strInfoComplementary4)
set the Information Complementary 4
|
void |
setInfoComplementary5(String strInfoComplementary5)
set the Information Complementary 5
|
void |
setIsShownFrontOfficeTitle(boolean bIsShownFrontOfficeTitle)
set the value of the boolean isShownFrontOfficeTitle
|
void |
setLibelleResetButton(String strLibelleResetButton)
The label to display for the Reset button
|
void |
setLibelleValidateButton(String libelleValidateButton)
set the label of the validate button
|
void |
setLimitNumberResponse(boolean numberResponse)
set true if the user can submit just one form
|
void |
setNbDaysBeforeCleaning(int nNbDaysBeforeCleaning)
Set the number of days to keep responses before cleaning them
|
void |
setRecap(Recap recap)
set the recap associated to the form
|
void |
setRequirement(String requirement)
set the requirement of the form
|
void |
setSupportHTTPS(boolean bSupportHTTPS)
Set to true if the form support HTTPS, false otherwise
|
void |
setTitle(String strTitle)
set the title of the form
|
void |
setUnavailabilityMessage(String unavailabilityMessage)
set the unavailability message of the form
|
void |
setWelcomeMessage(String strWelcomeMessage)
set the welcome message of the form
|
void |
setWorkgroup(String workGroup)
set the work group associate to the form
|
public static final String ROLE_NONE
public static final String RESOURCE_TYPE
public static final int STATE_ENABLE
public static final int STATE_DISABLE
public static void init()
public int getIdMailingList()
public void setIdMailingList(int mailingListId)
mailingListId
- the id of the mailing list associate to the formpublic String getCodeTheme()
public void setCodeTheme(String strCodeTheme)
strCodeTheme
- the theme codepublic boolean isActiveCaptcha()
public void setActiveCaptcha(boolean activeCaptcha)
activeCaptcha
- true if the form contain a captchapublic boolean isActiveStoreAdresse()
public void setActiveStoreAdresse(boolean activeStoreAdrese)
activeStoreAdrese
- true if the ip adresse of the user must be storepublic boolean isActiveRequirement()
public void setActiveRequirement(boolean activeRequirement)
activeRequirement
- true if the form contain requirementpublic String getLibelleValidateButton()
public void setLibelleValidateButton(String libelleValidateButton)
libelleValidateButton
- the label of the validate buttonpublic Date getDateEndDisponibility()
public void setDateEndDisponibility(Date dateEndDisponibility)
dateEndDisponibility
- the date of end of disponibilitypublic String getRequirement()
public void setRequirement(String requirement)
requirement
- the requirement of the formpublic String getTitle()
public void setTitle(String strTitle)
strTitle
- the title of the formpublic String getFrontOfficeTitle()
public void setFrontOfficeTitle(String strFrontOfficeTitle)
strFrontOfficeTitle
- the title to setpublic boolean isShownFrontOfficeTitle()
public void setIsShownFrontOfficeTitle(boolean bIsShownFrontOfficeTitle)
bIsShownFrontOfficeTitle
- The value of the boolean
isShownFrontOfficeTitlepublic String getDescription()
public void setDescription(String description)
description
- the description of the formpublic String getWelcomeMessage()
public void setWelcomeMessage(String strWelcomeMessage)
strWelcomeMessage
- the welcome message of the formpublic String getUnavailabilityMessage()
public void setUnavailabilityMessage(String unavailabilityMessage)
unavailabilityMessage
- the unavailability message of the formpublic String getWorkgroup()
getWorkgroup
in interface fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource
public void setWorkgroup(String workGroup)
workGroup
- the work group associate to the formpublic int getIdForm()
public void setIdForm(int idForm)
idForm
- the id of the formpublic boolean isActive()
public void setActive(boolean active)
active
- true if the form is activepublic boolean isLimitNumberResponse()
public void setLimitNumberResponse(boolean numberResponse)
numberResponse
- true if the user can submit just one formpublic Timestamp getDateCreation()
public void setDateCreation(Timestamp dateCreation)
dateCreation
- the creation datepublic Recap getRecap()
public void setRecap(Recap recap)
recap
- the recap associated to the formpublic String getResourceTypeCode()
getResourceTypeCode
in interface fr.paris.lutece.portal.service.rbac.RBACResource
public String getResourceId()
getResourceId
in interface fr.paris.lutece.portal.service.rbac.RBACResource
public List<FormAction> getActions()
public void setActions(List<FormAction> formActions)
formActions
- a list of action must be use for the formpublic int getFormPageId()
public void setFormPageId(int formPageId)
formPageId
- the id of the page which contain the formpublic void setDateBeginDisponibility(Date tDateBeginDisponibility)
tDateBeginDisponibility
- The date begin of the publicationpublic Date getDateBeginDisponibility()
public void setAutoPublicationActive(boolean bAutoPublicationActive)
bAutoPublicationActive
- True if Auto publication is effectively
activepublic boolean isAutoPublicationActive()
public boolean isAutoPublished()
public void setLibelleResetButton(String strLibelleResetButton)
strLibelleResetButton
- The labelpublic String getLibelleResetButton()
public String getInfoComplementary1()
public void setInfoComplementary1(String strInfoComplementary1)
strInfoComplementary1
- the Information Complementary 1public String getInfoComplementary2()
public void setInfoComplementary2(String strInfoComplementary2)
strInfoComplementary2
- the Information Complementary 2public String getInfoComplementary3()
public void setInfoComplementary3(String strInfoComplementary3)
strInfoComplementary3
- the Information Complementary 3public String getInfoComplementary4()
public void setInfoComplementary4(String strInfoComplementary4)
strInfoComplementary4
- the Information Complementary 4public String getInfoComplementary5()
public void setInfoComplementary5(String strInfoComplementary5)
strInfoComplementary5
- the Information Complementary 5public void setSupportHTTPS(boolean bSupportHTTPS)
bSupportHTTPS
- the support valuepublic boolean isSupportHTTPS()
public boolean isActiveMyLuteceAuthentification()
public void setActiveMyLuteceAuthentification(boolean bActiveMyLuteceAuthentification)
bActiveMyLuteceAuthentification
- true if the form require mylutece
authenticationpublic Category getCategory()
public void setCategory(Category category)
category
- the category associate to the formpublic boolean getAutomaticCleaning()
public void setAutomaticCleaning(boolean bAutomaticCleaning)
bAutomaticCleaning
- True if this form should be cleaned
automatically by the daemon, false otherwisepublic boolean getCleaningByRemoval()
public void setCleaningByRemoval(boolean bCleaningByRemoval)
bCleaningByRemoval
- true if the cleaning operation is a remove
operation, false if it is an anonymization operationpublic int getNbDaysBeforeCleaning()
public void setNbDaysBeforeCleaning(int nNbDaysBeforeCleaning)
nNbDaysBeforeCleaning
- The number of days to keep responses before
cleaning themCopyright © 2016 City of Paris. All rights reserved.