Class FormDetail
- java.lang.Object
-
- org.silverpeas.components.formsonline.model.FormDetail
-
public class FormDetail extends Object
-
-
Field Summary
Fields Modifier and Type Field Description static List<String>
ALL_RECEIVER_TYPES
static List<String>
ALL_RIGHT_TYPES
static String
RECEIVERS_TYPE_FINAL
static String
RECEIVERS_TYPE_INTERMEDIATE
static String
SENDERS_TYPE
static int
STATE_NOT_YET_PUBLISHED
static int
STATE_PUBLISHED
static int
STATE_UNPUBLISHED
static int
VALIDATOR_NOT_ALLOWED
static int
VALIDATOR_OK
static int
VALIDATOR_UNDEFINED
-
Constructor Summary
Constructors Constructor Description FormDetail()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canBeSentBy(org.silverpeas.core.admin.user.model.User user)
boolean
equals(Object o)
protected List<org.silverpeas.core.admin.user.model.User>
getAllFinalReceivers()
protected List<org.silverpeas.core.admin.user.model.User>
getAllIntermediateReceivers()
Date
getCreationDate()
String
getCreatorId()
String
getDescription()
String
getHierarchicalValidatorOfCurrentUser()
int
getHierarchicalValidatorState()
int
getId()
String
getInstanceId()
List<org.silverpeas.core.admin.user.model.Group>
getIntermediateReceiversAsGroups()
List<org.silverpeas.core.admin.user.model.User>
getIntermediateReceiversAsUsers()
String
getName()
int
getNbRequests()
FormPK
getPK()
Map<FormInstanceValidationType,Function<FormInstance,Supplier<List<org.silverpeas.core.admin.user.model.User>>>>
getPossibleRequestValidations()
Gets the possible request validations.List<org.silverpeas.core.admin.user.model.Group>
getReceiversAsGroups()
List<org.silverpeas.core.admin.user.model.User>
getReceiversAsUsers()
Optional<String>
getRequestExchangeReceiver()
Gets the receiver data which permits to exchange the data of a new form request.List<org.silverpeas.core.admin.user.model.Group>
getSendersAsGroups()
List<org.silverpeas.core.admin.user.model.User>
getSendersAsUsers()
int
getState()
String
getTitle()
String
getXmlFormName()
int
hashCode()
boolean
isDeleteAfterRequestExchange()
Indicates id the exchanged form request MUST be deleted after the exchange processing.boolean
isFinalValidation()
boolean
isFinalValidator(String userId)
boolean
isHierarchicalValidation()
Indicates if the hierarchical validation enabled.boolean
isIntermediateValidation()
boolean
isIntermediateValidator(String userId)
boolean
isNotYetPublished()
boolean
isPublished()
boolean
isSendable()
boolean
isUnpublished()
boolean
isValidator(String userId)
void
setCreationDate(Date creationDate)
void
setCreatorId(String creatorId)
void
setDeleteAfterRequestExchange(boolean deleteAfterRequestExchange)
Sets the behavior about the deletion of a new form request when it has just been exchanged with the receiver procided bygetRequestExchangeReceiver()
method.void
setDescription(String description)
void
setHierarchicalValidation(boolean hierarchicalValidation)
Sets the hierarchical validation flag.void
setId(int id)
void
setInstanceId(String instanceId)
void
setIntermediateReceiversAsGroups(List<org.silverpeas.core.admin.user.model.Group> receiversAsGroups)
void
setIntermediateReceiversAsUsers(List<org.silverpeas.core.admin.user.model.User> receiversAsUsers)
void
setName(String name)
void
setNbRequests(int nbRequests)
void
setReceiversAsGroups(List<org.silverpeas.core.admin.user.model.Group> receiversAsGroups)
void
setReceiversAsUsers(List<org.silverpeas.core.admin.user.model.User> receiversAsUsers)
void
setRequestExchangeReceiver(String requestExchangeReceiver)
Sets the receiver data (an e-mail for now) which permits to perform the exchange of a new form request creation.void
setSendable(boolean sendable)
void
setSendersAsGroups(List<org.silverpeas.core.admin.user.model.Group> sendersAsGroups)
void
setSendersAsUsers(List<org.silverpeas.core.admin.user.model.User> sendersAsUsers)
void
setState(int state)
void
setTitle(String title)
void
setXmlFormName(String xmlFormName)
-
-
-
Field Detail
-
STATE_NOT_YET_PUBLISHED
public static final int STATE_NOT_YET_PUBLISHED
- See Also:
- Constant Field Values
-
STATE_PUBLISHED
public static final int STATE_PUBLISHED
- See Also:
- Constant Field Values
-
STATE_UNPUBLISHED
public static final int STATE_UNPUBLISHED
- See Also:
- Constant Field Values
-
VALIDATOR_OK
public static final int VALIDATOR_OK
- See Also:
- Constant Field Values
-
VALIDATOR_UNDEFINED
public static final int VALIDATOR_UNDEFINED
- See Also:
- Constant Field Values
-
VALIDATOR_NOT_ALLOWED
public static final int VALIDATOR_NOT_ALLOWED
- See Also:
- Constant Field Values
-
SENDERS_TYPE
public static final String SENDERS_TYPE
- See Also:
- Constant Field Values
-
RECEIVERS_TYPE_INTERMEDIATE
public static final String RECEIVERS_TYPE_INTERMEDIATE
- See Also:
- Constant Field Values
-
RECEIVERS_TYPE_FINAL
public static final String RECEIVERS_TYPE_FINAL
- See Also:
- Constant Field Values
-
-
Method Detail
-
getId
public int getId()
- Returns:
- the id
-
getTitle
public String getTitle()
- Returns:
- the title
-
setTitle
public void setTitle(String title)
- 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
public Date getCreationDate()
- Returns:
- the creationDate
-
setCreationDate
public void setCreationDate(Date creationDate)
- Parameters:
creationDate
- the creationDate to set
-
setId
public void setId(int id)
- Parameters:
id
- the id to set
-
getXmlFormName
public String getXmlFormName()
- Returns:
- the xmlFormName
-
setXmlFormName
public void setXmlFormName(String xmlFormName)
- Parameters:
xmlFormName
- the xmlFormName to set
-
getName
public String getName()
- Returns:
- the name
-
setName
public void setName(String name)
- Parameters:
name
- the name to set
-
getDescription
public String getDescription()
- Returns:
- the description
-
setDescription
public void setDescription(String description)
- Parameters:
description
- the description to set
-
getCreatorId
public String getCreatorId()
- Returns:
- the creatorId
-
setCreatorId
public void setCreatorId(String creatorId)
- Parameters:
creatorId
- the creatorId to set
-
getInstanceId
public String getInstanceId()
- Returns:
- the instanceId
-
setInstanceId
public void setInstanceId(String instanceId)
- Parameters:
instanceId
- the instanceId to set
-
isHierarchicalValidation
public boolean isHierarchicalValidation()
Indicates if the hierarchical validation enabled.- Returns:
- true if enabled, false othserwise.
-
setHierarchicalValidation
public void setHierarchicalValidation(boolean hierarchicalValidation)
Sets the hierarchical validation flag.- Parameters:
hierarchicalValidation
- true to enabled, false otherwise.
-
getRequestExchangeReceiver
public Optional<String> 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
public void setRequestExchangeReceiver(String requestExchangeReceiver)
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 procided bygetRequestExchangeReceiver()
method.- Parameters:
deleteAfterRequestExchange
- true if a new form request MUST be deleted after exchange, false otherwise.
-
isPublished
public boolean isPublished()
-
isUnpublished
public boolean isUnpublished()
-
isNotYetPublished
public boolean isNotYetPublished()
-
setSendable
public void setSendable(boolean sendable)
-
isSendable
public boolean isSendable()
-
isValidator
public boolean isValidator(String userId)
-
getPK
public FormPK getPK()
-
getSendersAsUsers
public List<org.silverpeas.core.admin.user.model.User> getSendersAsUsers()
-
setSendersAsUsers
public void setSendersAsUsers(List<org.silverpeas.core.admin.user.model.User> sendersAsUsers)
-
getSendersAsGroups
public List<org.silverpeas.core.admin.user.model.Group> getSendersAsGroups()
-
setSendersAsGroups
public void setSendersAsGroups(List<org.silverpeas.core.admin.user.model.Group> sendersAsGroups)
-
getReceiversAsUsers
public List<org.silverpeas.core.admin.user.model.User> getReceiversAsUsers()
-
setReceiversAsUsers
public void setReceiversAsUsers(List<org.silverpeas.core.admin.user.model.User> receiversAsUsers)
-
getReceiversAsGroups
public List<org.silverpeas.core.admin.user.model.Group> getReceiversAsGroups()
-
setReceiversAsGroups
public void setReceiversAsGroups(List<org.silverpeas.core.admin.user.model.Group> receiversAsGroups)
-
getAllFinalReceivers
protected List<org.silverpeas.core.admin.user.model.User> getAllFinalReceivers()
-
getIntermediateReceiversAsUsers
public List<org.silverpeas.core.admin.user.model.User> getIntermediateReceiversAsUsers()
-
setIntermediateReceiversAsUsers
public void setIntermediateReceiversAsUsers(List<org.silverpeas.core.admin.user.model.User> receiversAsUsers)
-
getIntermediateReceiversAsGroups
public List<org.silverpeas.core.admin.user.model.Group> getIntermediateReceiversAsGroups()
-
setIntermediateReceiversAsGroups
public void setIntermediateReceiversAsGroups(List<org.silverpeas.core.admin.user.model.Group> receiversAsGroups)
-
getAllIntermediateReceivers
protected List<org.silverpeas.core.admin.user.model.User> getAllIntermediateReceivers()
-
isIntermediateValidator
public boolean isIntermediateValidator(String userId)
-
isFinalValidator
public boolean isFinalValidator(String userId)
-
isFinalValidation
public boolean isFinalValidation()
-
isIntermediateValidation
public boolean isIntermediateValidation()
-
getNbRequests
public int getNbRequests()
-
setNbRequests
public void setNbRequests(int nbRequests)
-
getHierarchicalValidatorOfCurrentUser
public String getHierarchicalValidatorOfCurrentUser()
-
getHierarchicalValidatorState
public int getHierarchicalValidatorState()
-
getPossibleRequestValidations
public Map<FormInstanceValidationType,Function<FormInstance,Supplier<List<org.silverpeas.core.admin.user.model.User>>>> getPossibleRequestValidations()
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
FormInstanceValidationType
enum.
-
canBeSentBy
public boolean canBeSentBy(org.silverpeas.core.admin.user.model.User user)
-
-