Package com.avoka.fc.core.entity

Class RequiredAttachment

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._RequiredAttachment

com.avoka.fc.core.entity.RequiredAttachment

All Implemented Interfaces:

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

public class RequiredAttachment
extends _RequiredAttachment

Provides an entity representing a SmartForm Manager managed attachment that is presented to the user after submission. It does not store the actual uploads but is only a marker of an attachment that is requested of the user.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAX_SIZE_FORMATTED_PROPERTY	An auxiliary property to get a formatted string describing the maximum attachment size
static final String	SUBMIT_METHOD_Electronic	Indicates that the user will have to attach files electronically
static final String	SUBMIT_METHOD_Manual	Indicates that the user will have to send in attachments via a manual process (e.g.

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

ATTACHMENT_NAME, ATTACHMENT_NAME_PROPERTY, ATTACHMENTS, ATTACHMENTS_PROPERTY, DESCRIPTION, DESCRIPTION_PROPERTY, DOCUMENT_CODE, DOCUMENT_CODE_PROPERTY, MAX_NUMBER, MAX_NUMBER_PROPERTY, MAX_RESOLUTION, MAX_RESOLUTION_PROPERTY, MAX_SIZE, MAX_SIZE_PROPERTY, MIME_OR_FILE_TYPES, MIME_OR_FILE_TYPES_PROPERTY, REQUIRED_ATTACHMENT_OID_PK_COLUMN, REQUIRED_FLAG, REQUIRED_FLAG_PROPERTY, SUBMISSION, SUBMISSION_PROPERTY, SUBMIT_MANUALLY_FLAG, SUBMIT_MANUALLY_FLAG_PROPERTY, SUBMIT_METHOD, SUBMIT_METHOD_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
RequiredAttachment()

Method Summary

Modifier and Type	Method	Description
String	getMaxSizeFormatted()	Return the maximum size as a formatted string
boolean	isSubmitElectronic()	Return whether the user will have to attach a file for this attachment electronically
boolean	isSubmitManual()	Return whether the user will have send in attachments manually (e.g.

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

addToAttachments, getAttachmentName, getAttachments, getDescription, getDocumentCode, getMaxNumber, getMaxResolution, getMaxSize, getMimeOrFileTypes, getSubmission, getSubmitMethod, isRequiredFlag, isSubmitManuallyFlag, removeFromAttachments, setAttachmentName, setDescription, setDocumentCode, setMaxNumber, setMaxResolution, setMaxSize, setMimeOrFileTypes, setRequiredFlag, setSubmission, setSubmitManuallyFlag, setSubmitMethod

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

Field Details

MAX_SIZE_FORMATTED_PROPERTY

public static final String MAX_SIZE_FORMATTED_PROPERTY

An auxiliary property to get a formatted string describing the maximum attachment size

See Also:

• Constant Field Values

SUBMIT_METHOD_Electronic

public static final String SUBMIT_METHOD_Electronic

Indicates that the user will have to attach files electronically

See Also:

• Constant Field Values

SUBMIT_METHOD_Manual

public static final String SUBMIT_METHOD_Manual

Indicates that the user will have to send in attachments via a manual process (e.g. fax)

See Also:

• Constant Field Values

Constructor Details

RequiredAttachment

public RequiredAttachment()

Method Details

isSubmitElectronic

public boolean isSubmitElectronic()

Return whether the user will have to attach a file for this attachment electronically

Returns:

true if the submit method is SUBMIT_METHOD_Electronic

isSubmitManual

public boolean isSubmitManual()

Return whether the user will have send in attachments manually (e.g. using fax)

Returns:

true if the submit method is SUBMIT_METHOD_Manual

getMaxSizeFormatted

public String getMaxSizeFormatted()

Return the maximum size as a formatted string

Returns:

the formatted maximum size

Since:

4.1.0