Package com.avoka.fc.core.servlet.dd.cmd

Class Command

  • public class Command
extends Object
    Provides a command value object.
    Since:
    17.10.0

    • Field Detail

      • TYPE_USER_SUBMIT

        public static final String TYPE_USER_SUBMIT
        Provides the "userSubmit" command.type.
        See Also:
        Constant Field Values

      • TYPE_USER_CANCEL

        public static final String TYPE_USER_CANCEL
        Provides the "userCancel" command.type.
        See Also:
        Constant Field Values

      • TYPE_FORM_INELIGIBLE

        public static final String TYPE_FORM_INELIGIBLE
        Provides the "formIneligible" command.type.
        See Also:
        Constant Field Values

      • TYPE_FORM_UPDATE

        public static final String TYPE_FORM_UPDATE
        Provides the "formUpdate" command.type.
        See Also:
        Constant Field Values

      • TYPE_FORM_FUNCTION

        public static final String TYPE_FORM_FUNCTION
        Provides the "formFunction" command.type.
        See Also:
        Constant Field Values

      • OPTION_EMAIL_ADDRESS

        public static final String OPTION_EMAIL_ADDRESS
        Provides the "emailAddress" command.options.
        See Also:
        Constant Field Values

      • OPTION_MILESTONE

        public static final String OPTION_MILESTONE
        Provides the "milestone" command.options.
        See Also:
        Constant Field Values

      • OPTION_SEND_EMAIL_FORM_RECEIPT

        public static final String OPTION_SEND_EMAIL_FORM_RECEIPT
        Provides the "sendEmailFormReceipt" command.options.
        See Also:
        Constant Field Values

      • OPTION_SEND_EMAIL_SAVED_FORM

        public static final String OPTION_SEND_EMAIL_SAVED_FORM
        Provides the "sendEmailSavedForm" command.options.
        See Also:
        Constant Field Values

      • OPTION_SEND_EMAIL_SHARE_FORM

        public static final String OPTION_SEND_EMAIL_SHARE_FORM
        Provides the "sendEmailShareForm" command.options.
        See Also:
        Constant Field Values

      • OPTION_STACKTRACE

        public static final String OPTION_STACKTRACE
        Provides the "stacktrace" command.options.
        See Also:
        Constant Field Values

      • OPTION_USER_SAVED

        public static final String OPTION_USER_SAVED
        Provides the "userSaved" command.options.
        See Also:
        Constant Field Values

      • OPTION_ADD_ATTACHMENT_FILE

        public static final String OPTION_ADD_ATTACHMENT_FILE
        Provides the "addAttachmentFile" command.options.
        See Also:
        Constant Field Values

      • OPTION_ADD_ATTACHMENT_MANUALLY

        public static final String OPTION_ADD_ATTACHMENT_MANUALLY
        Provides the "addAttachmentManually" command.options.
        See Also:
        Constant Field Values

      • OPTION_REMOVE_ATTACHMENT

        public static final String OPTION_REMOVE_ATTACHMENT
        Provides the "removeAttachment" command.options.
        See Also:
        Constant Field Values

      • OPTION_SAVE_CHALLENGE_ANSWER

        public static final String OPTION_SAVE_CHALLENGE_ANSWER
        Provides the "saveChallengeAnswer" command.options.
        See Also:
        Constant Field Values

      • OPTION_FORM_CODE

        public static final String OPTION_FORM_CODE
        Provides the "formCode" command.options.
        See Also:
        Constant Field Values

      • OPTION_FORM_VERSION

        public static final String OPTION_FORM_VERSION
        Provides the "formVersion" command.options.
        See Also:
        Constant Field Values

      • OPTION_TRACKING_CODE

        public static final String OPTION_TRACKING_CODE
        Provides the "trackingCode" command.options.
        See Also:
        Constant Field Values

      • type

        public String type
        Specifies the command type.

      • requestKey

        public String requestKey
        Specifies the command requestKey.

      • options

        public Map options
        Specifies the command options.

      • parameters

        public Map<String,​Object> parameters
        Specifies the command parameters.

    • Constructor Detail

      • Command

        public Command()

    • Method Detail

      • getOptionsValue

        public Object getOptionsValue​(String name)
        Return the command.options value for the given name, or null if not found.
        Parameters:
        name - the command.options key name
        Returns:
        the command.options value for the given name, or null if not found

      • hasOptionsValue

        public boolean hasOptionsValue​(String key)
        Return true if the command.options has a value for the given key.
        Parameters:
        key - the command.options key name
        Returns:
        true if the command.options has a value for the given key

      • isOptionsUserSaved

        public boolean isOptionsUserSaved()
        Return true if command.options["userSaved"] is defined and true
        Returns:
        true if command.options["userSaved"] is defined and true

      • isOptionsSendEmailFormReceipt

        public boolean isOptionsSendEmailFormReceipt()
        Return true if command.options["sendEmailFormReceipt"] is defined and true
        Returns:
        true if command.options["sendEmailFormReceipt"] is defined and true

      • isOptionsSendEmailSavedForm

        public boolean isOptionsSendEmailSavedForm()
        Return true if command.options["sendEmailSavedForm"] is defined and true
        Returns:
        true if command.options["sendEmailSavedForm"] is defined and true

      • isOptionsSendEmailShareForm

        public boolean isOptionsSendEmailShareForm()
        Return true if command.options["sendEmailShareForm"] is defined and true
        Returns:
        true if command.options["sendEmailShareForm"] is defined and true

      • getOptionsContext

        public String getOptionsContext()
        Return the command.options["context"] value if defined
        Returns:
        the command.options["context"] value if defined
        Since:
        18.5.0

      • getOptionsMilestone

        public String getOptionsMilestone()
        Return the command.options["milestone"] value if defined
        Returns:
        the command.options["milestone"] value if defined

      • getOptionsAddAttachmentFile

        public com.avoka.fc.core.servlet.dd.cmd.AddAttachmentFile getOptionsAddAttachmentFile()
        Return the command.options["addAttachmentFile"] value if defined
        Returns:
        the command.options["addAttachmentFile"] value if defined

      • getOptionsAddAttachmentManually

        public com.avoka.fc.core.servlet.dd.cmd.AddAttachmentManually getOptionsAddAttachmentManually()
        Return the command.options["addAttachmentManually"] value if defined
        Returns:
        the command.options["addAttachmentManually"] value if defined

      • getOptionsRemoveAttachment

        public com.avoka.fc.core.servlet.dd.cmd.RemoveAttachment getOptionsRemoveAttachment()
        Return the command.options["removeAttachment"] value if defined
        Returns:
        the command.options["removeAttachment"] value if defined

      • getOptionsEmailAddress

        public String getOptionsEmailAddress()
        Return the command.options["emailAddress"] value if defined
        Returns:
        the command.options["emailAddress"] value if defined

      • getOptionsSaveChallengeAnswer

        public String getOptionsSaveChallengeAnswer()
        Return the command.options["saveChallengeAnswer"] value if defined
        Returns:
        the command.options["saveChallengeAnswer"] value if defined
        Since:
        18.11.0

      • getOptionsStracktrace

        public String getOptionsStracktrace()
        Return the command.options["stacktrace"] value if defined
        Returns:
        the command.options["stacktrace"] value if defined
        Since:
        18.5.0

      • getOptionsTrackingCode

        public String getOptionsTrackingCode()
        Return the command.options["trackingCode"] value if defined
        Returns:
        the command.options["trackingCode"] value if defined
        Since:
        18.11.0

      • isTypeFormError

        public boolean isTypeFormError()
        Return true if command.type = "formError"
        Returns:
        true if command.type = "formError"
        Since:
        18.5.0

      • isTypeFormFunction

        public boolean isTypeFormFunction()
        Return true if command.type = "formFunction"
        Returns:
        true if command.type = "formFunction"

      • isTypeFormIneligible

        public boolean isTypeFormIneligible()
        Return true if command.type = "formIneligible"
        Returns:
        true if command.type = "formIneligible"

      • isTypeFormInit

        public boolean isTypeFormInit()
        Return true if command.type = "formInit"
        Returns:
        true if command.type = "formInit"
        Since:
        18.5.0

      • isTypeFormLoad

        public boolean isTypeFormLoad()
        Return true if command.type = "formLoad"
        Returns:
        true if command.type = "formLoad"
        Since:
        18.11.0

      • isTypeFormNew

        public boolean isTypeFormNew()
        Return true if command.type = "formNew"
        Returns:
        true if command.type = "formNew"
        Since:
        18.11.0

      • isTypeFormStart

        public boolean isTypeFormStart()
        Return true if command.type = "formStart"
        Returns:
        true if command.type = "formStart"

      • isTypeFormUpdate

        public boolean isTypeFormUpdate()
        Return true if command.type = "formUpdate"
        Returns:
        true if command.type = "formUpdate"

      • isTypeUserCancel

        public boolean isTypeUserCancel()
        Return true if command.type = "userCancel"
        Returns:
        true if command.type = "userCancel"

      • isTypeUserSave

        public boolean isTypeUserSave()
        Return true if command.type = "userSave"
        Returns:
        true if command.type = "userSave"

      • isTypeUserSubmit

        public boolean isTypeUserSubmit()
        Return true if command.type = "userSubmit"
        Returns:
        true if command.type = "userSubmit"

      • requiresFormData

        public boolean requiresFormData()
        Return true if the command type requires formData to be performed.
        Returns:
        true if the command type requires formData to be performed
        Since:
        18.11.0

      • toString

        public String toString()
        Overrides:
        toString in class Object
        Returns:
        a string representation of the object.