Package com.avoka.fc.core.entity

Class RequestLog

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._RequestLog
com.avoka.fc.core.entity.RequestLog
All Implemented Interfaces:
IEntity, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating
public class RequestLog extends _RequestLog
Provides a record around requests for a form, either for fill-in or receipt rendering.
See Also:

  • Field Details

    • CLIENT_CODE_PROPERTY

      public static final String CLIENT_CODE_PROPERTY
      Provides the 'clientCode' property name.
      See Also:

    • CLIENT_NAME_PROPERTY

      public static final String CLIENT_NAME_PROPERTY
      Provides the 'clientName' property name.
      See Also:

    • FORM_CODE_PROPERTY

      public static final String FORM_CODE_PROPERTY
      Provides the 'formCode' property name.
      See Also:

    • FORM_NAME_PROPERTY

      public static final String FORM_NAME_PROPERTY
      Provides the 'formName' property name.
      See Also:

    • FORM_SERVER_NAME_PROPERTY

      public static final String FORM_SERVER_NAME_PROPERTY
      Provides the 'formServerName' property name.
      See Also:

    • FORM_VERSION_NUMBER_PROPERTY

      public static final String FORM_VERSION_NUMBER_PROPERTY
      Provides the 'formVersionNumber' property name.
      See Also:

    • PORTAL_SERVER_NAME_PROPERTY

      public static final String PORTAL_SERVER_NAME_PROPERTY
      Provides the 'portalServerName' property name.
      See Also:

    • USER_AGENT_BROWSER_PROPERTY

      public static final String USER_AGENT_BROWSER_PROPERTY
      An auxiliary property combining all available information about the user's browser
      See Also:

    • USER_AGENT_OS_PROPERTY

      public static final String USER_AGENT_OS_PROPERTY
      An auxiliary property combining all available information about the user's operating system
      See Also:

    • USER_AGENT_BROWSER_TYPE_PROPERTY

      public static final String USER_AGENT_BROWSER_TYPE_PROPERTY
      Provides the 'userAgentBrowserType' property name.
      See Also:

    • USER_AGENT_BROWSER_VERSION_PROPERTY

      public static final String USER_AGENT_BROWSER_VERSION_PROPERTY
      Provides the 'userAgentBrowserVersion' property name.
      See Also:

    • USER_AGENT_OS_TYPE_PROPERTY

      public static final String USER_AGENT_OS_TYPE_PROPERTY
      Provides the 'userAgentOsType' property name.
      See Also:

    • USER_AGENT_OS_VERSION_PROPERTY

      public static final String USER_AGENT_OS_VERSION_PROPERTY
      Provides the 'userAgentOsVersion' property name.
      See Also:

    • MODE_FORM

      public static final String MODE_FORM
      Indicates that a form was requested for fill-in
      See Also:

    • MODE_RECEIPT

      public static final String MODE_RECEIPT
      Indicates that a receipt was requested
      See Also:

    • MODES

      public static final String[] MODES
      The set of all request render modes

    • RECEIPT_MODE_WEB

      public static final String RECEIPT_MODE_WEB
      Indicates that a receipt render via the web
      See Also:

    • RECEIPT_MODE_EMAIL

      public static final String RECEIPT_MODE_EMAIL
      Indicates that a receipt render via the email
      See Also:

    • RECEIPT_MODE_DELIVERY

      public static final String RECEIPT_MODE_DELIVERY
      Indicates that a receipt render via the delivery
      See Also:

    • RECEIPT_MODES

      public static final String[] RECEIPT_MODES
      The set of all request receipt modes

  • Constructor Details

    • RequestLog

      public RequestLog()

  • Method Details

    • getClientCode

      public String getClientCode()
      Return the clientCode value. Provided for backward compatibility.
      Returns:
      clientCode the clientCode value
      Since:
      5.1.0

    • getClientName

      public String getClientName()
      Return the clientName value. Provided for backward compatibility.
      Returns:
      clientName the clientName value
      Since:
      5.1.0

    • getFormCode

      public String getFormCode()
      Return the formCode value. Provided for backward compatibility.
      Returns:
      formCode the formCode value
      Since:
      5.1.0

    • getFormName

      public String getFormName()
      Return the formName value. Provided for backward compatibility.
      Returns:
      formName the formName value
      Since:
      5.1.0

    • getFormServerName

      public String getFormServerName()
      Return the formServerName value. Provided for backward compatibility.
      Returns:
      formServerName the formServerName value
      Since:
      5.1.0

    • getFormVersionNumber

      public String getFormVersionNumber()
      Return the formVersionNumber value. Provided for backward compatibility.
      Returns:
      formVersionNumber the formVersionNumber value
      Since:
      5.1.0

    • getPortalServerName

      public String getPortalServerName()
      Return the portalServerName value. Provided for backward compatibility.
      Returns:
      portalServerName the portalServerName value
      Since:
      5.1.0

    • getUserAgentBrowserType

      public String getUserAgentBrowserType()
      Return the userAgentBrowserType value.Provided for backward compatibility.
      Returns:
      userAgentBrowserType the userAgentBrowserType value
      Since:
      5.1.0

    • getUserAgentBrowserVersion

      public String getUserAgentBrowserVersion()
      Return the userAgentBrowserVersion value. Provided for backward compatibility.
      Returns:
      userAgentBrowserVersion the userAgentBrowserVersion value
      Since:
      5.1.0

    • getUserAgentOsType

      public String getUserAgentOsType()
      Return the userAgentOsType value. Provided for backward compatibility.
      Returns:
      userAgentOsType the userAgentOsType value
      Since:
      5.1.0

    • getUserAgentOsVersion

      public String getUserAgentOsVersion()
      Return the userAgentOsVersion value. Provided for backward compatibility.
      Returns:
      userAgentOsVersion the userAgentOsVersion value
      Since:
      5.1.0

    • getUserAgentBrowser

      public String getUserAgentBrowser()
      Return information about the user's browser
      Returns:
      a combination of _RequestLog#USER_AGENT_BROWSER_TYPE_PROPERTY and _RequestLog#USER_AGENT_BROWSER_VERSION_PROPERTY

    • getUserAgentOs

      public String getUserAgentOs()
      Return information about the user's operating system
      Returns:
      a combination of _RequestLog#USER_AGENT_OS_TYPE_PROPERTY and _RequestLog#USER_AGENT_OS_VERSION_PROPERTY

    • isFormRender

      public boolean isFormRender()
      Return whether the user requested a form for fill-in
      Returns:
      true if the render mode is MODE_FORM

    • isReceiptRender

      public boolean isReceiptRender()
      Return whether the user requested a form receipt
      Returns:
      true if the render mode is MODE_RECEIPT

    • isLcFormsRequest

      @Deprecated public boolean isLcFormsRequest()
      Deprecated.
      do not use; this will be removed in a future release
      Returns:
      false

    • setLcFormsRequest

      @Deprecated public void setLcFormsRequest(boolean isLcFormsRequest)
      Deprecated.
      do not use; this will be removed in a future release
      Parameters:
      isLcFormsRequest - unused

    • isLcDsigRequest

      @Deprecated public boolean isLcDsigRequest()
      Deprecated.
      do not use; this will be removed in a future release
      Returns:
      false

    • setLcDsigRequest

      @Deprecated public void setLcDsigRequest(boolean isLcDsigRequest)
      Deprecated.
      do not use; this will be removed in a future release
      Parameters:
      isLcDsigRequest - unused

    • isLcReaderExtensionsRequest

      @Deprecated public boolean isLcReaderExtensionsRequest()
      Deprecated.
      do not use; this will be removed in a future release
      Returns:
      false

    • setLcReaderExtensionsRequest

      @Deprecated public void setLcReaderExtensionsRequest(boolean isLcReRequest)
      Deprecated.
      do not use; this will be removed in a future release
      Parameters:
      isLcReRequest - unused

    • setDatetimeCreated

      public void setDatetimeCreated(Date datetimeCreated)
      Description copied from class: _RequestLog
      Set the datetimeCreated value.
      Overrides:
      setDatetimeCreated in class _RequestLog
      Parameters:
      datetimeCreated - the datetimeCreated value to set

    • setRequestTimestamp

      public void setRequestTimestamp(Date requestTimestamp)
      Description copied from class: _RequestLog
      Set the requestTimestamp value.
      Overrides:
      setRequestTimestamp in class _RequestLog
      Parameters:
      requestTimestamp - the requestTimestamp value to set

    • setTimeLastUserActivity

      public void setTimeLastUserActivity(Date timeLastUserActivity)
      Description copied from class: _RequestLog
      Set the timeLastUserActivity value.
      Overrides:
      setTimeLastUserActivity in class _RequestLog
      Parameters:
      timeLastUserActivity - the timeLastUserActivity value to set