Class FormDetail
java.lang.Object
org.silverpeas.components.formsonline.model.FormDetail
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleancanBeSentBy(org.silverpeas.core.admin.user.model.User user) booleanprotected List<org.silverpeas.core.admin.user.model.User> protected List<org.silverpeas.core.admin.user.model.User> intintgetId()List<org.silverpeas.core.admin.user.model.Group> List<org.silverpeas.core.admin.user.model.User> getName()intgetPK()Map<FormInstanceValidationType, Function<FormInstance, Supplier<List<org.silverpeas.core.admin.user.model.User>>>> Gets the possible request validations.List<org.silverpeas.core.admin.user.model.Group> List<org.silverpeas.core.admin.user.model.User> Gets the receiver data which permits to exchange the data of a new form request.List<org.silverpeas.core.admin.user.model.Group> List<org.silverpeas.core.admin.user.model.User> intgetState()getTitle()inthashCode()booleanIndicates id the exchanged form request MUST be deleted after the exchange processing.booleanbooleanisFinalValidator(String userId) booleanIndicates if the hierarchical validation enabled.booleanbooleanisIntermediateValidator(String userId) booleanbooleanbooleanbooleanbooleanisValidator(String userId) voidsetCreationDate(Date creationDate) voidsetCreatorId(String creatorId) voidsetDeleteAfterRequestExchange(boolean deleteAfterRequestExchange) Sets the behavior about the deletion of a new form request when it has just been exchanged with the receiver provided bygetRequestExchangeReceiver()method.voidsetDescription(String description) voidsetHierarchicalValidation(boolean hierarchicalValidation) Sets the hierarchical validation flag.voidsetId(int id) voidsetInstanceId(String instanceId) voidsetIntermediateReceiversAsGroups(List<org.silverpeas.core.admin.user.model.Group> receiversAsGroups) voidsetIntermediateReceiversAsUsers(List<org.silverpeas.core.admin.user.model.User> receiversAsUsers) voidvoidsetNbRequests(int nbRequests) voidsetReceiversAsGroups(List<org.silverpeas.core.admin.user.model.Group> receiversAsGroups) voidsetReceiversAsUsers(List<org.silverpeas.core.admin.user.model.User> receiversAsUsers) voidsetRequestExchangeReceiver(String requestExchangeReceiver) Sets the receiver data (an e-mail for now) which permits to perform the exchange of a new form request creation.voidsetSendable(boolean sendable) voidsetSendersAsGroups(List<org.silverpeas.core.admin.user.model.Group> sendersAsGroups) voidsetSendersAsUsers(List<org.silverpeas.core.admin.user.model.User> sendersAsUsers) voidsetState(int state) voidvoidsetXmlFormName(String xmlFormName)
-
Field Details
-
STATE_NOT_YET_PUBLISHED
public static final int STATE_NOT_YET_PUBLISHED- See Also:
-
STATE_PUBLISHED
public static final int STATE_PUBLISHED- See Also:
-
STATE_UNPUBLISHED
public static final int STATE_UNPUBLISHED- See Also:
-
VALIDATOR_OK
public static final int VALIDATOR_OK- See Also:
-
VALIDATOR_UNDEFINED
public static final int VALIDATOR_UNDEFINED- See Also:
-
VALIDATOR_NOT_ALLOWED
public static final int VALIDATOR_NOT_ALLOWED- See Also:
-
SENDERS_TYPE
- See Also:
-
RECEIVERS_TYPE_INTERMEDIATE
- See Also:
-
RECEIVERS_TYPE_FINAL
- See Also:
-
ALL_RIGHT_TYPES
-
ALL_RECEIVER_TYPES
-
-
Constructor Details
-
FormDetail
public FormDetail()
-
-
Method Details
-
getId
public int getId()- Returns:
- the id
-
getTitle
- Returns:
- the title
-
setTitle
- Parameters:
title- the title to set
-
getState
public int getState()- Returns:
- the state
-
setState
public void setState(int state) - Parameters:
state- the state to set
-
getCreationDate
- Returns:
- the creationDate
-
setCreationDate
- Parameters:
creationDate- the creationDate to set
-
setId
public void setId(int id) - Parameters:
id- the id to set
-
getXmlFormName
- Returns:
- the xmlFormName
-
setXmlFormName
- Parameters:
xmlFormName- the xmlFormName to set
-
getName
- Returns:
- the name
-
setName
- Parameters:
name- the name to set
-
getDescription
- Returns:
- the description
-
setDescription
- Parameters:
description- the description to set
-
getCreatorId
- Returns:
- the creatorId
-
setCreatorId
- Parameters:
creatorId- the creatorId to set
-
getInstanceId
- Returns:
- the instanceId
-
setInstanceId
- Parameters:
instanceId- the instanceId to set
-
isHierarchicalValidation
public boolean isHierarchicalValidation()Indicates if the hierarchical validation enabled.- Returns:
- true if enabled, false otherwise.
-
setHierarchicalValidation
public void setHierarchicalValidation(boolean hierarchicalValidation) Sets the hierarchical validation flag.- Parameters:
hierarchicalValidation- true to enabled, false otherwise.
-
getRequestExchangeReceiver
Gets the receiver data which permits to exchange the data of a new form request.If filled, just after its creation the new form request is exchanged with the given receiver.
For now, the receiver is represented by an e-mail. By this way, the data are sent to the receiver just after a new form request creation.
- Returns:
- an optional receiver data in charge of request exchange processing.
-
setRequestExchangeReceiver
Sets the receiver data (an e-mail for now) which permits to perform the exchange of a new form request creation.- Parameters:
requestExchangeReceiver- receiver data (an e-mail for now)
-
isDeleteAfterRequestExchange
public boolean isDeleteAfterRequestExchange()Indicates id the exchanged form request MUST be deleted after the exchange processing.If method
getRequestExchangeReceiver()returns no receiver data, then no deletion is indicated.- Returns:
- true if a new form request MUST be deleted after exchange, false otherwise.
-
setDeleteAfterRequestExchange
public void setDeleteAfterRequestExchange(boolean deleteAfterRequestExchange) Sets the behavior about the deletion of a new form request when it has just been exchanged with the receiver provided bygetRequestExchangeReceiver()method.- Parameters:
deleteAfterRequestExchange- true if a new form request MUST be deleted after exchange, false otherwise.
-
equals
-
hashCode
public int hashCode() -
isPublished
public boolean isPublished() -
isUnpublished
public boolean isUnpublished() -
isNotYetPublished
public boolean isNotYetPublished() -
setSendable
public void setSendable(boolean sendable) -
isSendable
public boolean isSendable() -
isValidator
-
getPK
-
getSendersAsUsers
-
setSendersAsUsers
-
getSendersAsGroups
-
setSendersAsGroups
-
getReceiversAsUsers
-
setReceiversAsUsers
-
getReceiversAsGroups
-
setReceiversAsGroups
public void setReceiversAsGroups(List<org.silverpeas.core.admin.user.model.Group> receiversAsGroups) -
getAllFinalReceivers
-
getIntermediateReceiversAsUsers
-
setIntermediateReceiversAsUsers
public void setIntermediateReceiversAsUsers(List<org.silverpeas.core.admin.user.model.User> receiversAsUsers) -
getIntermediateReceiversAsGroups
-
setIntermediateReceiversAsGroups
public void setIntermediateReceiversAsGroups(List<org.silverpeas.core.admin.user.model.Group> receiversAsGroups) -
getAllIntermediateReceivers
-
isIntermediateValidator
-
isFinalValidator
-
isFinalValidation
public boolean isFinalValidation() -
isIntermediateValidation
public boolean isIntermediateValidation() -
getNbRequests
public int getNbRequests() -
setNbRequests
public void setNbRequests(int nbRequests) -
getHierarchicalValidatorOfCurrentUser
-
getHierarchicalValidatorState
public int getHierarchicalValidatorState() -
getPossibleRequestValidations
public Map<FormInstanceValidationType,Function<FormInstance, getPossibleRequestValidations()Supplier<List<org.silverpeas.core.admin.user.model.User>>>> Gets the possible request validations.For each request validation, a validator provider is provided.
BE CAREFUL of that following methods MUST have been called before using this method:
- Returns:
- a map of validation type associated to a validator list supplier. Keys of map are
sorted as the
FormInstanceValidationTypeenum.
-
canBeSentBy
public boolean canBeSentBy(org.silverpeas.core.admin.user.model.User user)
-