Package com.avoka.fc.core.entity

Class DeliveryDetails

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

com.avoka.fc.core.entity.DeliveryDetails

All Implemented Interfaces:

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

@CacheGroups("CONFIG")
public class DeliveryDetails
extends _DeliveryDetails
implements Auditable

Provides an entity describing how and where a submission shall be delivered.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	DELIVERY_METHODS	The set of delivery methods
static final String	METHOD_DELIVERY_PROCESS	The "Delivery Process" delivery method.
static final String	METHOD_EMAIL	The standard "Email" delivery method.
static final String	METHOD_EMAIL_SECURE	The "Email Secure" delivery method.
static final String	METHOD_REST_SERVICE	The "REST Service" delivery method.
static final String	METHOD_WEB_SERVICE	The "Web Service" delivery method.

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

ABANDON_FORMS, ABANDON_FORMS_PROPERTY, ABANDON_TEMPLATE_SUBMISSIONS, ABANDON_TEMPLATE_SUBMISSIONS_PROPERTY, APPLICATION_DELIVERY_LIST, APPLICATION_DELIVERY_LIST_PROPERTY, CLIENT, CLIENT_PROPERTY, DEFAULT_DELIVERY_DETAILS_FLAG, DEFAULT_DELIVERY_DETAILS_FLAG_PROPERTY, DELIVER_EXCEL_FLAG, DELIVER_EXCEL_FLAG_PROPERTY, DELIVER_PDF_FLAG, DELIVER_PDF_FLAG_PROPERTY, DELIVER_XML_FLAG, DELIVER_XML_FLAG_PROPERTY, DELIVERY_DETAILS_OID_PK_COLUMN, DELIVERY_METHOD, DELIVERY_METHOD_PROPERTY, DELIVERY_PROCESS_NAME, DELIVERY_PROCESS_NAME_PROPERTY, DELIVERY_PROCESS_SERVICE, DELIVERY_PROCESS_SERVICE_PROPERTY, DESCRIPTION, DESCRIPTION_PROPERTY, DISABLED_FLAG, DISABLED_FLAG_PROPERTY, EMAIL_ADDRESSES, EMAIL_ADDRESSES_PROPERTY, EMAIL_CC_ADDRESSES, EMAIL_CC_ADDRESSES_PROPERTY, EMAIL_INCLUDE_USER_ATTACHMENTS, EMAIL_INCLUDE_USER_ATTACHMENTS_PROPERTY, EMAIL_MAX_ATTACHMENTS_SIZE, EMAIL_MAX_ATTACHMENTS_SIZE_PROPERTY, EMAIL_MESSAGE, EMAIL_MESSAGE_PROPERTY, EMAIL_SUBJECT, EMAIL_SUBJECT_PROPERTY, FILENAME_TEMPLATE, FILENAME_TEMPLATE_PROPERTY, NAME, NAME_PROPERTY, PDF_RECEIPT_EMBED_DATA_FLAG, PDF_RECEIPT_EMBED_DATA_FLAG_PROPERTY, PROD_FORM_SUBMISSIONS, PROD_FORM_SUBMISSIONS_PROPERTY, PROD_TEMPLATE_SUBMISSIONS, PROD_TEMPLATE_SUBMISSIONS_PROPERTY, RETRY_DELAY_MINS, RETRY_DELAY_MINS_PROPERTY, SUBMISSIONS, SUBMISSIONS_PROPERTY, TEST_FORM_SUBMISSIONS, TEST_FORM_SUBMISSIONS_PROPERTY, TEST_TEMPLATE_SUBMISSIONS, TEST_TEMPLATE_SUBMISSIONS_PROPERTY, VALIDATION_FORMS, VALIDATION_FORMS_PROPERTY, VALIDATION_TEMPLATE_SUBMISSIONS, VALIDATION_TEMPLATE_SUBMISSIONS_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
DeliveryDetails()

Method Summary

Modifier and Type	Method	Description
boolean	isEmailDeliveryMethod()	Return whether delivery will be done via standard email
boolean	isEmailSecureDeliveryMethod()	Return whether delivery will be done via secure email
boolean	isProcessDeliveryMethod()	Return whether delivery will be done via a delivery process
boolean	isRestServiceDeliveryMethod()	Return whether delivery will be done via a rest service
boolean	isWebServiceDeliveryMethod()	Return whether delivery will be done via a web service

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

addToAbandonForms, addToAbandonTemplateSubmissions, addToApplicationDeliveryList, addToProdFormSubmissions, addToProdTemplateSubmissions, addToSubmissions, addToTestFormSubmissions, addToTestTemplateSubmissions, addToValidationForms, addToValidationTemplateSubmissions, getAbandonForms, getAbandonTemplateSubmissions, getApplicationDeliveryList, getClient, getDeliveryMethod, getDeliveryProcessName, getDeliveryProcessService, getDescription, getEmailAddresses, getEmailCcAddresses, getEmailMaxAttachmentsSize, getEmailMessage, getEmailSubject, getFilenameTemplate, getName, getProdFormSubmissions, getProdTemplateSubmissions, getRetryDelayMins, getSubmissions, getTestFormSubmissions, getTestTemplateSubmissions, getValidationForms, getValidationTemplateSubmissions, isDefaultDeliveryDetailsFlag, isDeliverExcelFlag, isDeliverPdfFlag, isDeliverXmlFlag, isDisabledFlag, isEmailIncludeUserAttachments, isPdfReceiptEmbedDataFlag, removeFromAbandonForms, removeFromAbandonTemplateSubmissions, removeFromApplicationDeliveryList, removeFromProdFormSubmissions, removeFromProdTemplateSubmissions, removeFromSubmissions, removeFromTestFormSubmissions, removeFromTestTemplateSubmissions, removeFromValidationForms, removeFromValidationTemplateSubmissions, setClient, setDefaultDeliveryDetailsFlag, setDeliverExcelFlag, setDeliverPdfFlag, setDeliverXmlFlag, setDeliveryMethod, setDeliveryProcessName, setDeliveryProcessService, setDescription, setDisabledFlag, setEmailAddresses, setEmailCcAddresses, setEmailIncludeUserAttachments, setEmailMaxAttachmentsSize, setEmailMessage, setEmailSubject, setFilenameTemplate, setName, setPdfReceiptEmbedDataFlag, setRetryDelayMins

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 com.avoka.fc.core.entity.Auditable

getId, getValuesMap

Methods inherited from interface org.apache.cayenne.Persistent

getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState

Field Details

METHOD_EMAIL

public static final String METHOD_EMAIL

The standard "Email" delivery method. Submissions are sent to a set of email addresses, with the form data attached to the email.

See Also:

• Constant Field Values

METHOD_EMAIL_SECURE

public static final String METHOD_EMAIL_SECURE

The "Email Secure" delivery method. Notifications are sent to a set of email addresses and contain a link to a SmartForm Manager page where the form data and attachments can be downloaded.

See Also:

• Constant Field Values

METHOD_DELIVERY_PROCESS

public static final String METHOD_DELIVERY_PROCESS

The "Delivery Process" delivery method. Submissions are sent to a Delivery Process, with the form data and attachments being passed in as parameters.

See Also:

• Constant Field Values

METHOD_REST_SERVICE

public static final String METHOD_REST_SERVICE

The "REST Service" delivery method. Submissions are delivered using a REST service API.

See Also:

• Constant Field Values

METHOD_WEB_SERVICE

public static final String METHOD_WEB_SERVICE

The "Web Service" delivery method. Submissions are delivered using a web service API. Several subtypes of web service delivery are available.

See Also:

• Constant Field Values

DELIVERY_METHODS

public static final String[] DELIVERY_METHODS

The set of delivery methods

Constructor Details

DeliveryDetails

public DeliveryDetails()

Method Details

isRestServiceDeliveryMethod

public boolean isRestServiceDeliveryMethod()

Return whether delivery will be done via a rest service

Returns:

true if the delivery method is REST Service

Since:

4.2.0

isWebServiceDeliveryMethod

public boolean isWebServiceDeliveryMethod()

Return whether delivery will be done via a web service

Returns:

true if the delivery method is Web Service

isEmailDeliveryMethod

public boolean isEmailDeliveryMethod()

Return whether delivery will be done via standard email

Returns:

true if the delivery method is Email

isEmailSecureDeliveryMethod

public boolean isEmailSecureDeliveryMethod()

Return whether delivery will be done via secure email

Returns:

true if the delivery method is Email Secure

isProcessDeliveryMethod

public boolean isProcessDeliveryMethod()

Return whether delivery will be done via a delivery process

Returns:

true if the delivery method is METHOD_DELIVERY_PROCESS

Since:

4.0.0