Package com.avoka.fc.core.entity

Class SubmissionHistory

java.lang.Object

org.apache.cayenne.PersistentObject

org.apache.cayenne.BaseDataObject

org.apache.cayenne.CayenneDataObject

com.avoka.core.entity.BaseEntity

com.avoka.fc.core.entity.auto._SubmissionHistory

com.avoka.fc.core.entity.SubmissionHistory

All Implemented Interfaces:

IEntity, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating

public class SubmissionHistory
extends _SubmissionHistory

Provides a record of a particular version of a submission. Every time a submission is saved, and when it is finally submitted, a submission history entry is saved.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.avoka.fc.core.entity.auto._SubmissionHistory

BACKGROUND_SAVED_FLAG, BACKGROUND_SAVED_FLAG_PROPERTY, DATETIME_CREATED, DATETIME_CREATED_PROPERTY, DELETED_FLAG, DELETED_FLAG_PROPERTY, FORM_STATUS, FORM_STATUS_PROPERTY, IP_ADDRESS, IP_ADDRESS_PROPERTY, PERCENTAGE_COMPLETED, PERCENTAGE_COMPLETED_PROPERTY, PORTAL_NAME, PORTAL_NAME_PROPERTY, REQUEST_LOG, REQUEST_LOG_PROPERTY, SHARE_FORM_FLAG, SHARE_FORM_FLAG_PROPERTY, STORAGE_ENCODING, STORAGE_ENCODING_PROPERTY, STORAGE_URL, STORAGE_URL_PROPERTY, SUBMISSION, SUBMISSION_HISTORY_DATA, SUBMISSION_HISTORY_DATA_PROPERTY, SUBMISSION_HISTORY_OID_PK_COLUMN, SUBMISSION_PROPERTY, TEMPLATE_VERSION, TEMPLATE_VERSION_PROPERTY, TIME_TO_SUBMIT_SEC, TIME_TO_SUBMIT_SEC_PROPERTY, USER, USER_AGENT, USER_AGENT_DEVICE_TYPE, USER_AGENT_DEVICE_TYPE_PROPERTY, USER_AGENT_PROPERTY, USER_PROPERTY

Fields inherited from class com.avoka.core.entity.BaseEntity

ID_PROPERTY

Fields inherited from class org.apache.cayenne.CayenneDataObject

values

Fields inherited from class org.apache.cayenne.BaseDataObject

snapshotVersion

Fields inherited from class org.apache.cayenne.PersistentObject

objectContext, objectId, persistenceState

Fields inherited from interface org.apache.cayenne.DataObject

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor	Description
SubmissionHistory()

Method Summary

Modifier and Type	Method	Description
String	getIpAddress()	Return the ipAddress value.
String	getPortalName()	Return the portalName value.
SubmissionHistoryData	getSubmissionHistoryData()	Deprecated.
TemplateVersion	getTemplateVersion()	Return the TemplateVersion.
UserAccount	getUser()	Return the User.
String	getUserAgent()	Return the userAgent value.
String	getUserAgentDeviceType()	Return the userAgentDeviceType value.
boolean	isFormAssigned()	Return whether the submission history is in status "Assigned"
boolean	isFormSaved()	Return whether the submission history is in status "Saved"
boolean	isFormSubmitted()	Return whether the submission history is in status "Submitted"
void	setDatetimeCreated(Date datetimeCreated)	Set the datetimeCreated value.
void	setSubmissionHistoryData(SubmissionHistoryData submissionHistoryData)	Deprecated.

Methods inherited from class com.avoka.fc.core.entity.auto._SubmissionHistory

getDatetimeCreated, getFormStatus, getPercentageCompleted, getRequestLog, getStorageEncoding, getStorageUrl, getSubmission, getTimeToSubmitSec, isBackgroundSavedFlag, isDeletedFlag, isShareFormFlag, setBackgroundSavedFlag, setDeletedFlag, setFormStatus, setIpAddress, setPercentageCompleted, setPortalName, setRequestLog, setShareFormFlag, setStorageEncoding, setStorageUrl, setSubmission, setTemplateVersion, setTimeToSubmitSec, setUser, setUserAgent, setUserAgentDeviceType

Methods inherited from class com.avoka.core.entity.BaseEntity

appendProperties, getId, getValuesMap, isNew, setId, toString

Methods inherited from class org.apache.cayenne.CayenneDataObject

makePath, readPropertyDirectly, readState, setPersistenceState, writePropertyDirectly, writeState

Methods inherited from class org.apache.cayenne.BaseDataObject

addToManyTarget, beforePropertyRead, beforePropertyWrite, getSnapshotVersion, readNestedProperty, readProperty, readSerialized, removeToManyTarget, setObjectContext, setReverseRelationship, setSnapshotVersion, setToManyTarget, setToOneTarget, toStringBuffer, unsetReverseRelationship, validateForDelete, validateForInsert, validateForSave, validateForUpdate, willConnect, writeProperty, writeSerialized

Methods inherited from class org.apache.cayenne.PersistentObject

getMapKey, getObjectContext, getObjectId, getPersistenceState, setObjectId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cayenne.Persistent

getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState

Constructor Details

SubmissionHistory

public SubmissionHistory()

Method Details

getIpAddress

public String getIpAddress()

Return the ipAddress value.

Overrides:

getIpAddress in class _SubmissionHistory

Returns:

ipAddress the ipAddress value

getPortalName

public String getPortalName()

Return the portalName value.

Overrides:

getPortalName in class _SubmissionHistory

Returns:

portalName the portalName value

getTemplateVersion

public TemplateVersion getTemplateVersion()

Return the TemplateVersion.

Overrides:

getTemplateVersion in class _SubmissionHistory

Returns:

the templateVersion value

getUserAgent

public String getUserAgent()

Return the userAgent value.

Overrides:

getUserAgent in class _SubmissionHistory

Returns:

userAgent the userAgent value

getUserAgentDeviceType

public String getUserAgentDeviceType()

Return the userAgentDeviceType value.

Overrides:

getUserAgentDeviceType in class _SubmissionHistory

Returns:

userAgentDeviceType the userAgentDeviceType value

getUser

public UserAccount getUser()

Return the User.

Overrides:

getUser in class _SubmissionHistory

Returns:

the user value

isFormAssigned

public boolean isFormAssigned()

Return whether the submission history is in status "Assigned"

Returns:

true if the form status is Submission.STATUS_Assigned

Since:

4.0.0

isFormSaved

public boolean isFormSaved()

Return whether the submission history is in status "Saved"

Returns:

true if the form status is Submission.STATUS_Saved

Since:

4.1.0

isFormSubmitted

public boolean isFormSubmitted()

Return whether the submission history is in status "Submitted"

Returns:

true if the form status is Submission.STATUS_Submitted

Since:

4.2.0

setSubmissionHistoryData

@Deprecated
public void setSubmissionHistoryData(SubmissionHistoryData submissionHistoryData)

Deprecated.

This method should not be used, instead please use the submissions associated Submission Data Storage service.

Overrides:

setSubmissionHistoryData in class _SubmissionHistory

Parameters:

submissionHistoryData - the submissionHistoryData value to set

Since:

4.2.0

getSubmissionHistoryData

@Deprecated
public SubmissionHistoryData getSubmissionHistoryData()

Deprecated.

This method should not be used, instead please use the submissions associated Submission Data Storage service.

Overrides:

getSubmissionHistoryData in class _SubmissionHistory

Returns:

the submissionHistoryData value

Since:

4.2.0

setDatetimeCreated

public void setDatetimeCreated(Date datetimeCreated)

Description copied from class: _SubmissionHistory

Set the datetimeCreated value.

Overrides:

setDatetimeCreated in class _SubmissionHistory

Parameters:

datetimeCreated - the datetimeCreated value to set