Package org.silverpeas.components.formsonline.model

Class FormInstance

java.lang.Object

org.silverpeas.components.formsonline.model.FormInstance

All Implemented Interfaces:

Serializable, org.silverpeas.core.contribution.model.Contribution, org.silverpeas.core.contribution.model.SilverpeasContent, org.silverpeas.core.Identifiable, org.silverpeas.core.Instance<org.silverpeas.core.contribution.model.Contribution>, org.silverpeas.core.Nameable, org.silverpeas.core.security.Securable, org.silverpeas.core.SilverpeasResource

public class FormInstance
extends Object
implements org.silverpeas.core.contribution.model.SilverpeasContent

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected FormDetail	form
static int	STATE_ARCHIVED
static int	STATE_CANCELED
static int	STATE_DRAFT
static int	STATE_READ
static int	STATE_REFUSED
static int	STATE_UNREAD
static int	STATE_VALIDATED

Constructor Summary

Constructors

Constructor	Description
FormInstance()

Method Summary

Modifier and Type	Method	Description
boolean	canBeAccessedBy(org.silverpeas.core.admin.user.model.User user)
boolean	canBeArchivedBy(org.silverpeas.core.admin.user.model.User user)
boolean	canBeCanceledBy(org.silverpeas.core.admin.user.model.User user)
boolean	canBeDeletedBy(org.silverpeas.core.admin.user.model.User user)
boolean	canBeValidated()
String	getComments()
String	getComponentInstanceId()
String	getContributionType()
Date	getCreationDate()
org.silverpeas.core.admin.user.model.User	getCreator()
String	getCreatorId()
String	getDescription()
FormDetail	getForm()
int	getFormId()
FormPK	getFormPK()
org.silverpeas.core.contribution.content.form.Form	getFormWithData()
String	getHierarchicalValidator()
String	getId()
int	getIdAsInt()
Date	getLastUpdateDate()
org.silverpeas.core.admin.user.model.User	getLastUpdater()
FormInstanceValidation	getPendingValidation()
RequestPK	getPK()
List<FormInstanceValidation>	getPreviousValidations()
int	getState()
String	getTitle()
Date	getValidationDate()
FormInstanceValidations	getValidations()	Gets all the validations performed on the form instance.
List<String>	getValidationsImages()
List<FormInstanceValidation>	getValidationsSchema()
org.silverpeas.core.admin.user.model.User	getValidator()
String	getValidatorId()
boolean	isArchived()
boolean	isCanceled()
boolean	isDenied()
boolean	isDraft()
boolean	isHierarchicalValidator(String userId)
boolean	isRead()
boolean	isUnread()
boolean	isValidated()
boolean	isValidationEnabled()
boolean	isVoidable()
void	setCreationDate(Date creationDate)
void	setCreatorId(String creatorId)
void	setForm(FormDetail form)
void	setFormId(int formId)
void	setFormWithData(org.silverpeas.core.contribution.content.form.Form formWithData)
void	setId(int id)
void	setInstanceId(String instanceId)
void	setState(int state)
void	setValidationEnabled(boolean validationEnabled)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.silverpeas.core.contribution.model.Contribution

getModel, getName, getResourcePath, isIndexable

Methods inherited from interface org.silverpeas.core.Instance

getParent

Methods inherited from interface org.silverpeas.core.security.Securable

canBeFiledInBy, canBeModifiedBy

Methods inherited from interface org.silverpeas.core.contribution.model.SilverpeasContent

getIdentifier, getSilverpeasContentId

Field Detail

STATE_DRAFT

public static final int STATE_DRAFT

See Also:

Constant Field Values

STATE_UNREAD

public static final int STATE_UNREAD

See Also:

Constant Field Values

STATE_READ

public static final int STATE_READ

See Also:

Constant Field Values

STATE_VALIDATED

public static final int STATE_VALIDATED

See Also:

Constant Field Values

STATE_REFUSED

public static final int STATE_REFUSED

See Also:

Constant Field Values

STATE_ARCHIVED

public static final int STATE_ARCHIVED

See Also:

Constant Field Values

STATE_CANCELED

public static final int STATE_CANCELED

See Also:

Constant Field Values

form

protected transient FormDetail form

Constructor Detail

FormInstance

public FormInstance()

Method Detail

getId

public String getId()

Specified by:

getId in interface org.silverpeas.core.Identifiable

Specified by:

getId in interface org.silverpeas.core.contribution.model.SilverpeasContent

setId

public void setId(int id)

Parameters:

id - the id to set

getIdAsInt

public int getIdAsInt()

getComponentInstanceId

public String getComponentInstanceId()

Specified by:

getComponentInstanceId in interface org.silverpeas.core.contribution.model.SilverpeasContent

getFormId

public int getFormId()

Returns:

the formId

setFormId

public void setFormId(int formId)

Parameters:

formId - the formId to set

getState

public int getState()

Returns:

the state

setState

public void setState(int state)

Parameters:

state - the state to set

getCreatorId

public String getCreatorId()

Returns:

the creatorId

setCreatorId

public void setCreatorId(String creatorId)

Parameters:

creatorId - the creatorId to set

getCreationDate

public Date getCreationDate()

Specified by:

getCreationDate in interface org.silverpeas.core.SilverpeasResource

Returns:

the creationDate

setCreationDate

public void setCreationDate(Date creationDate)

Parameters:

creationDate - the creationDate to set

getLastUpdateDate

public Date getLastUpdateDate()

Specified by:

getLastUpdateDate in interface org.silverpeas.core.SilverpeasResource

getTitle

public String getTitle()

Specified by:

getTitle in interface org.silverpeas.core.contribution.model.Contribution

getDescription

public String getDescription()

Specified by:

getDescription in interface org.silverpeas.core.contribution.model.Contribution

Specified by:

getDescription in interface org.silverpeas.core.Nameable

getContributionType

public String getContributionType()

Specified by:

getContributionType in interface org.silverpeas.core.contribution.model.Contribution

canBeAccessedBy

public boolean canBeAccessedBy(org.silverpeas.core.admin.user.model.User user)

Specified by:

canBeAccessedBy in interface org.silverpeas.core.contribution.model.Contribution

Specified by:

canBeAccessedBy in interface org.silverpeas.core.security.Securable

canBeDeletedBy

public boolean canBeDeletedBy(org.silverpeas.core.admin.user.model.User user)

Specified by:

canBeDeletedBy in interface org.silverpeas.core.security.Securable

getHierarchicalValidator

public String getHierarchicalValidator()

isHierarchicalValidator

public boolean isHierarchicalValidator(String userId)

getValidations

public FormInstanceValidations getValidations()

Gets all the validations performed on the form instance.

Returns:

a FormInstanceValidations instance.

getPreviousValidations

public List<FormInstanceValidation> getPreviousValidations()

getValidationsSchema

public List<FormInstanceValidation> getValidationsSchema()

getPendingValidation

public FormInstanceValidation getPendingValidation()

getValidatorId

public String getValidatorId()

Returns:

the validatorId

getValidationDate

public Date getValidationDate()

Returns:

the validationDate

getComments

public String getComments()

Returns:

the comments

setInstanceId

public void setInstanceId(String instanceId)

Parameters:

instanceId - the instanceId to set

getForm

public FormDetail getForm()

setForm

public void setForm(FormDetail form)

isRead

public boolean isRead()

isUnread

public boolean isUnread()

isCanceled

public boolean isCanceled()

isValidated

public boolean isValidated()

isDenied

public boolean isDenied()

isArchived

public boolean isArchived()

canBeValidated

public boolean canBeValidated()

canBeArchivedBy

public boolean canBeArchivedBy(org.silverpeas.core.admin.user.model.User user)

canBeCanceledBy

public boolean canBeCanceledBy(org.silverpeas.core.admin.user.model.User user)

isDraft

public boolean isDraft()

getCreator

public org.silverpeas.core.admin.user.model.User getCreator()

Specified by:

getCreator in interface org.silverpeas.core.SilverpeasResource

getLastUpdater

public org.silverpeas.core.admin.user.model.User getLastUpdater()

Specified by:

getLastUpdater in interface org.silverpeas.core.SilverpeasResource

getValidator

public org.silverpeas.core.admin.user.model.User getValidator()

getFormPK

public FormPK getFormPK()

isValidationEnabled

public boolean isValidationEnabled()

setValidationEnabled

public void setValidationEnabled(boolean validationEnabled)

getFormWithData

public org.silverpeas.core.contribution.content.form.Form getFormWithData()

setFormWithData

public void setFormWithData(org.silverpeas.core.contribution.content.form.Form formWithData)

getPK

public RequestPK getPK()

isVoidable

public boolean isVoidable()

getValidationsImages

public List<String> getValidationsImages()