Class SubmissionEmailVerificationService
- java.lang.Object
-
- com.avoka.fc.core.service.BaseService
-
- com.avoka.fc.core.service.CayenneService
-
- com.avoka.fc.core.service.submission.SubmissionEmailVerificationService
-
- All Implemented Interfaces:
ISubmissionEmailVerificationService
public class SubmissionEmailVerificationService extends CayenneService implements ISubmissionEmailVerificationService
Provides an form submission email verification service class.
-
-
Constructor Summary
Constructors Constructor Description SubmissionEmailVerificationService()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDefaultEmailMessage()
Return the default email messageString
getDefaultEmailSubject()
Return the default email subjectInteger
getDefaultMaxAttempts()
Return the default maximum number of attempts (= number of emails to send to the user)Integer
getDefaultReminderIntervalHours()
Return the default reminder interval in hours (= hours between sending verification emails if user hasn't responded)Integer
getDefaultTimeoutDays()
Return the default timeout in days after which email verification is considered failed.String
getProcessingStatusAbandoned()
Return the processing status descriptor for abandoned email verificationString
getProcessingStatusCompleted()
Return the processing status descriptor for completed email verificationString
getProcessingStatusPending()
Return the processing status descriptor for pending email verificationString
getProcessingStatusRequired()
Return the processing status descriptor for required email verificationString
getProcessingStatusWarning()
Return the processing status descriptor for email verification for which no more emails will be sent (maximum number of attempts reached)void
logProcessingStatus(Submission submission)
Log a processing status after the email verification status for a submission has changed.void
processOutstandingEmailVerifications()
Process the outstanding email verifications.void
sendInitialEmailVerification(Submission submission)
Send an initial user email verification email for the given submissionvoid
setDefaultEmailMessage(String defaultEmailMessage)
Set the default email messagevoid
setDefaultEmailSubject(String defaultEmailSubject)
Set the default email subjectvoid
setDefaultMaxAttempts(Integer defaultMaxAttempts)
Set the default maximum number of attempts (= number of emails to send to the user)void
setDefaultReminderIntervalHours(Integer defaultReminderIntervalHours)
Set the default reminder interval in hours (= hours between sending verification emails if user hasn't responded)void
setDefaultTimeoutDays(Integer defaultTimeoutDays)
Set the default timeout in days after which email verification is considered failed.void
setProcessingStatusAbandoned(String processingStatusAbandoned)
Set the processing status descriptor for abandoned email verificationvoid
setProcessingStatusCompleted(String processingStatusCompleted)
Set the processing status descriptor for completed email verificationvoid
setProcessingStatusPending(String processingStatusPending)
Set the processing status descriptor for pending email verificationvoid
setProcessingStatusRequired(String processingStatusRequired)
Set the processing status descriptor for required email verificationvoid
setProcessingStatusWarning(String processingStatusWarning)
Set the processing status descriptor for email verification for which no more emails will be sent (maximum number of attempts reached)-
Methods inherited from class com.avoka.fc.core.service.CayenneService
commitChanges, deleteObject, deleteObjects, findObject, getDataContext, getDataDomain, getObjectForPK, getObjectStore, newObject, performNamedQuery, performNamedQuery, performNamedQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performQuery, performQuery, refetchEntity, refetchObject, registerNewObject, rollbackChanges, toMap, toMap
-
Methods inherited from class com.avoka.fc.core.service.BaseService
getLogger
-
-
-
-
Method Detail
-
sendInitialEmailVerification
public void sendInitialEmailVerification(Submission submission)
Send an initial user email verification email for the given submission- Specified by:
sendInitialEmailVerification
in interfaceISubmissionEmailVerificationService
- Parameters:
submission
- the submission (required)- See Also:
ISubmissionEmailVerificationService.sendInitialEmailVerification(Submission)
-
processOutstandingEmailVerifications
public void processOutstandingEmailVerifications()
Description copied from interface:ISubmissionEmailVerificationService
Process the outstanding email verifications.- Specified by:
processOutstandingEmailVerifications
in interfaceISubmissionEmailVerificationService
-
logProcessingStatus
public void logProcessingStatus(Submission submission)
Log a processing status after the email verification status for a submission has changed.- Specified by:
logProcessingStatus
in interfaceISubmissionEmailVerificationService
- Parameters:
submission
- the submission (required; the email verification status must already be changed)- Since:
- 4.3.3
-
getDefaultTimeoutDays
public Integer getDefaultTimeoutDays()
Return the default timeout in days after which email verification is considered failed.- Specified by:
getDefaultTimeoutDays
in interfaceISubmissionEmailVerificationService
- Returns:
- the default timeout in days
-
setDefaultTimeoutDays
public void setDefaultTimeoutDays(Integer defaultTimeoutDays)
Set the default timeout in days after which email verification is considered failed.- Parameters:
defaultTimeoutDays
- the default timeout in days
-
getDefaultMaxAttempts
public Integer getDefaultMaxAttempts()
Return the default maximum number of attempts (= number of emails to send to the user)- Specified by:
getDefaultMaxAttempts
in interfaceISubmissionEmailVerificationService
- Returns:
- the default maximum number of attempts
-
setDefaultMaxAttempts
public void setDefaultMaxAttempts(Integer defaultMaxAttempts)
Set the default maximum number of attempts (= number of emails to send to the user)- Parameters:
defaultMaxAttempts
- the default maximum number of attempts
-
getDefaultReminderIntervalHours
public Integer getDefaultReminderIntervalHours()
Return the default reminder interval in hours (= hours between sending verification emails if user hasn't responded)- Specified by:
getDefaultReminderIntervalHours
in interfaceISubmissionEmailVerificationService
- Returns:
- the default reminder interval
-
setDefaultReminderIntervalHours
public void setDefaultReminderIntervalHours(Integer defaultReminderIntervalHours)
Set the default reminder interval in hours (= hours between sending verification emails if user hasn't responded)- Parameters:
defaultReminderIntervalHours
- the default reminder interval
-
getDefaultEmailSubject
public String getDefaultEmailSubject()
Return the default email subject- Specified by:
getDefaultEmailSubject
in interfaceISubmissionEmailVerificationService
- Returns:
- the default email subject
-
setDefaultEmailSubject
public void setDefaultEmailSubject(String defaultEmailSubject)
Set the default email subject- Parameters:
defaultEmailSubject
- the default email subject
-
getDefaultEmailMessage
public String getDefaultEmailMessage()
Return the default email message- Specified by:
getDefaultEmailMessage
in interfaceISubmissionEmailVerificationService
- Returns:
- the default email message
-
setDefaultEmailMessage
public void setDefaultEmailMessage(String defaultEmailMessage)
Set the default email message- Parameters:
defaultEmailMessage
- the default email message
-
getProcessingStatusRequired
public String getProcessingStatusRequired()
Return the processing status descriptor for required email verification- Returns:
- the processing status descriptor for required email verification
-
setProcessingStatusRequired
public void setProcessingStatusRequired(String processingStatusRequired)
Set the processing status descriptor for required email verification- Parameters:
processingStatusRequired
- the processing status descriptor for required email verification
-
getProcessingStatusPending
public String getProcessingStatusPending()
Return the processing status descriptor for pending email verification- Returns:
- the processing status descriptor for pending email verification
-
setProcessingStatusPending
public void setProcessingStatusPending(String processingStatusPending)
Set the processing status descriptor for pending email verification- Parameters:
processingStatusPending
- the processing status descriptor for pending email verification
-
getProcessingStatusCompleted
public String getProcessingStatusCompleted()
Return the processing status descriptor for completed email verification- Returns:
- the processing status descriptor for completed email verification
-
setProcessingStatusCompleted
public void setProcessingStatusCompleted(String processingStatusCompleted)
Set the processing status descriptor for completed email verification- Parameters:
processingStatusCompleted
- the processing status descriptor for completed email verification
-
getProcessingStatusWarning
public String getProcessingStatusWarning()
Return the processing status descriptor for email verification for which no more emails will be sent (maximum number of attempts reached)- Returns:
- the processing status descriptor for email verification for which no more emails will be sent
-
setProcessingStatusWarning
public void setProcessingStatusWarning(String processingStatusWarning)
Set the processing status descriptor for email verification for which no more emails will be sent (maximum number of attempts reached)- Parameters:
processingStatusWarning
- the processing status descriptor for email verification for which no more emails will be sent
-
getProcessingStatusAbandoned
public String getProcessingStatusAbandoned()
Return the processing status descriptor for abandoned email verification- Returns:
- the processing status descriptor for abandoned email verification
-
setProcessingStatusAbandoned
public void setProcessingStatusAbandoned(String processingStatusAbandoned)
Set the processing status descriptor for abandoned email verification- Parameters:
processingStatusAbandoned
- the processing status descriptor for abandoned email verification
-
-