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:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CLIENT_CODE_PROPERTY`	Provides the 'clientCode' property name.
`static String`	`CLIENT_NAME_PROPERTY`	Provides the 'clientName' property name.
`static String`	`FORM_CODE_PROPERTY`	Provides the 'formCode' property name.
`static String`	`FORM_NAME_PROPERTY`	Provides the 'formName' property name.
`static String`	`FORM_SERVER_NAME_PROPERTY`	Provides the 'formServerName' property name.
`static String`	`FORM_VERSION_NUMBER_PROPERTY`	Provides the 'formVersionNumber' property name.
`static String`	`MODE_FORM`	Indicates that a form was requested for fill-in
`static String`	`MODE_RECEIPT`	Indicates that a receipt was requested
`static String[]`	`MODES`	The set of all request render modes
`static String`	`PORTAL_SERVER_NAME_PROPERTY`	Provides the 'portalServerName' property name.
`static String`	`RECEIPT_MODE_DELIVERY`	Indicates that a receipt render via the delivery
`static String`	`RECEIPT_MODE_EMAIL`	Indicates that a receipt render via the email
`static String`	`RECEIPT_MODE_WEB`	Indicates that a receipt render via the web
`static String[]`	`RECEIPT_MODES`	The set of all request receipt modes
`static String`	`USER_AGENT_BROWSER_PROPERTY`	An auxiliary property combining all available information about the user's browser
`static String`	`USER_AGENT_BROWSER_TYPE_PROPERTY`	Provides the 'userAgentBrowserType' property name.
`static String`	`USER_AGENT_BROWSER_VERSION_PROPERTY`	Provides the 'userAgentBrowserVersion' property name.
`static String`	`USER_AGENT_OS_PROPERTY`	An auxiliary property combining all available information about the user's operating system
`static String`	`USER_AGENT_OS_TYPE_PROPERTY`	Provides the 'userAgentOsType' property name.
`static String`	`USER_AGENT_OS_VERSION_PROPERTY`	Provides the 'userAgentOsVersion' property name.

Fields inherited from class com.avoka.fc.core.entity.auto._RequestLog
CLIENT, CLIENT_PROPERTY, DATETIME_CREATED, DATETIME_CREATED_PROPERTY, DURATION_CLIENT_RESPONSE, DURATION_CLIENT_RESPONSE_PROPERTY, DURATION_FORM_INIT, DURATION_FORM_INIT_PROPERTY, DURATION_RENDER, DURATION_RENDER_PROPERTY, DURATION_TOTAL, DURATION_TOTAL_PROPERTY, EXTERNAL_PROFILE_ID, EXTERNAL_PROFILE_ID_PROPERTY, EXTERNAL_USER_ID, EXTERNAL_USER_ID_PROPERTY, FORM, FORM_DATA_ENCRYPT_FLAG, FORM_DATA_ENCRYPT_FLAG_PROPERTY, FORM_PROPERTY, FORM_RENDERED_LENGTH, FORM_RENDERED_LENGTH_PROPERTY, FORM_SERVER, FORM_SERVER_PROPERTY, FORM_STREAMED_LENGTH, FORM_STREAMED_LENGTH_PROPERTY, FORM_TYPE, FORM_TYPE_PROPERTY, IP_ADDRESS, IP_ADDRESS_PROPERTY, MILESTONES, MILESTONES_PROPERTY, PORTAL, PORTAL_PROPERTY, PORTAL_SERVER, PORTAL_SERVER_PROPERTY, RECEIPT_MODE, RECEIPT_MODE_PROPERTY, REFERER, REFERER_PROPERTY, REMOTE_USER, REMOTE_USER_PROPERTY, RENDER_MODE, RENDER_MODE_PROPERTY, REQUEST_CONTENT_LENGTH, REQUEST_CONTENT_LENGTH_PROPERTY, REQUEST_CONTENT_TYPE, REQUEST_CONTENT_TYPE_PROPERTY, REQUEST_COOKIE, REQUEST_COOKIE_PROPERTY, REQUEST_KEY, REQUEST_KEY_PROPERTY, REQUEST_METHOD, REQUEST_METHOD_PROPERTY, REQUEST_OID_PK_COLUMN, REQUEST_QUERY, REQUEST_QUERY_PROPERTY, REQUEST_TIMESTAMP, REQUEST_TIMESTAMP_PROPERTY, REQUEST_URL, REQUEST_URL_PROPERTY, SESSION_ID, SESSION_ID_PROPERTY, SUBMISSION, SUBMISSION_COUNT, SUBMISSION_COUNT_PROPERTY, SUBMISSION_HISTORIES, SUBMISSION_HISTORIES_PROPERTY, SUBMISSION_PROPERTY, TEMPLATE_VERSION, TEMPLATE_VERSION_PROPERTY, TIME_LAST_USER_ACTIVITY, TIME_LAST_USER_ACTIVITY_PROPERTY, USER, USER_AGENT, USER_AGENT_DEVICE_TYPE, USER_AGENT_DEVICE_TYPE_PROPERTY, USER_AGENT_PROPERTY, USER_PROFILE, USER_PROFILE_PROPERTY, USER_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

RequestLog()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getClientCode()`	Return the clientCode value.
`String`	`getClientName()`	Return the clientName value.
`String`	`getFormCode()`	Return the formCode value.
`String`	`getFormName()`	Return the formName value.
`String`	`getFormServerName()`	Return the formServerName value.
`String`	`getFormVersionNumber()`	Return the formVersionNumber value.
`String`	`getPortalServerName()`	Return the portalServerName value.
`String`	`getUserAgentBrowser()`	Return information about the user's browser
`String`	`getUserAgentBrowserType()`	Return the userAgentBrowserType value.Provided for backward compatibility.
`String`	`getUserAgentBrowserVersion()`	Return the userAgentBrowserVersion value.
`String`	`getUserAgentOs()`	Return information about the user's operating system
`String`	`getUserAgentOsType()`	Return the userAgentOsType value.
`String`	`getUserAgentOsVersion()`	Return the userAgentOsVersion value.
`boolean`	`isFormRender()`	Return whether the user requested a form for fill-in
`boolean`	`isLcDsigRequest()`	Deprecated. do not use; this will be removed in a future release
`boolean`	`isLcFormsRequest()`	Deprecated. do not use; this will be removed in a future release
`boolean`	`isLcReaderExtensionsRequest()`	Deprecated. do not use; this will be removed in a future release
`boolean`	`isReceiptRender()`	Return whether the user requested a form receipt
`void`	`setLcDsigRequest(boolean isLcDsigRequest)`	Deprecated. do not use; this will be removed in a future release
`void`	`setLcFormsRequest(boolean isLcFormsRequest)`	Deprecated. do not use; this will be removed in a future release
`void`	`setLcReaderExtensionsRequest(boolean isLcReRequest)`	Deprecated. do not use; this will be removed in a future release

Methods inherited from class com.avoka.fc.core.entity.auto._RequestLog
addToMilestones, addToSubmissionHistories, getClient, getDatetimeCreated, getDurationClientResponse, getDurationFormInit, getDurationRender, getDurationTotal, getExternalProfileId, getExternalUserId, getForm, getFormRenderedLength, getFormServer, getFormStreamedLength, getFormType, getIpAddress, getMilestones, getPortal, getPortalServer, getReceiptMode, getReferer, getRemoteUser, getRenderMode, getRequestContentLength, getRequestContentType, getRequestCookie, getRequestKey, getRequestMethod, getRequestQuery, getRequestTimestamp, getRequestUrl, getSessionId, getSubmission, getSubmissionCount, getSubmissionHistories, getTemplateVersion, getTimeLastUserActivity, getUser, getUserAgent, getUserAgentDeviceType, getUserProfile, isFormDataEncryptFlag, removeFromMilestones, removeFromSubmissionHistories, setClient, setDatetimeCreated, setDurationClientResponse, setDurationFormInit, setDurationRender, setDurationTotal, setExternalProfileId, setExternalUserId, setForm, setFormDataEncryptFlag, setFormRenderedLength, setFormServer, setFormStreamedLength, setFormType, setIpAddress, setPortal, setPortalServer, setReceiptMode, setReferer, setRemoteUser, setRenderMode, setRequestContentLength, setRequestContentType, setRequestCookie, setRequestKey, setRequestMethod, setRequestQuery, setRequestTimestamp, setRequestUrl, setSessionId, setSubmission, setSubmissionCount, setTemplateVersion, setTimeLastUserActivity, setUser, setUserAgent, setUserAgentDeviceType, setUserProfile

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 Detail
  - CLIENT_CODE_PROPERTY
```
public static final String CLIENT_CODE_PROPERTY
```
    Provides the 'clientCode' property name.
    
    See Also:
    
    Constant Field Values
  - CLIENT_NAME_PROPERTY
```
public static final String CLIENT_NAME_PROPERTY
```
    Provides the 'clientName' property name.
    
    See Also:
    
    Constant Field Values
  - FORM_CODE_PROPERTY
```
public static final String FORM_CODE_PROPERTY
```
    Provides the 'formCode' property name.
    
    See Also:
    
    Constant Field Values
  - FORM_NAME_PROPERTY
```
public static final String FORM_NAME_PROPERTY
```
    Provides the 'formName' property name.
    
    See Also:
    
    Constant Field Values
  - FORM_SERVER_NAME_PROPERTY
```
public static final String FORM_SERVER_NAME_PROPERTY
```
    Provides the 'formServerName' property name.
    
    See Also:
    
    Constant Field Values
  - FORM_VERSION_NUMBER_PROPERTY
```
public static final String FORM_VERSION_NUMBER_PROPERTY
```
    Provides the 'formVersionNumber' property name.
    
    See Also:
    
    Constant Field Values
  - PORTAL_SERVER_NAME_PROPERTY
```
public static final String PORTAL_SERVER_NAME_PROPERTY
```
    Provides the 'portalServerName' property name.
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - USER_AGENT_BROWSER_TYPE_PROPERTY
```
public static final String USER_AGENT_BROWSER_TYPE_PROPERTY
```
    Provides the 'userAgentBrowserType' property name.
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_BROWSER_VERSION_PROPERTY
```
public static final String USER_AGENT_BROWSER_VERSION_PROPERTY
```
    Provides the 'userAgentBrowserVersion' property name.
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_OS_TYPE_PROPERTY
```
public static final String USER_AGENT_OS_TYPE_PROPERTY
```
    Provides the 'userAgentOsType' property name.
    
    See Also:
    
    Constant Field Values
  - USER_AGENT_OS_VERSION_PROPERTY
```
public static final String USER_AGENT_OS_VERSION_PROPERTY
```
    Provides the 'userAgentOsVersion' property name.
    
    See Also:
    
    Constant Field Values
  - MODE_FORM
```
public static final String MODE_FORM
```
    Indicates that a form was requested for fill-in
    
    See Also:
    
    Constant Field Values
  - MODE_RECEIPT
```
public static final String MODE_RECEIPT
```
    Indicates that a receipt was requested
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - RECEIPT_MODE_EMAIL
```
public static final String RECEIPT_MODE_EMAIL
```
    Indicates that a receipt render via the email
    
    See Also:
    
    Constant Field Values
  - RECEIPT_MODE_DELIVERY
```
public static final String RECEIPT_MODE_DELIVERY
```
    Indicates that a receipt render via the delivery
    
    See Also:
    
    Constant Field Values
  - RECEIPT_MODES
```
public static final String[] RECEIPT_MODES
```
    The set of all request receipt modes
- Constructor Detail
  - RequestLog
```
public RequestLog()
```
- Method Detail
  - 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

Class RequestLog

Field Summary

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

Fields inherited from class com.avoka.core.entity.BaseEntity

Fields inherited from class org.apache.cayenne.CayenneDataObject

Fields inherited from class org.apache.cayenne.BaseDataObject

Fields inherited from class org.apache.cayenne.PersistentObject

Fields inherited from interface org.apache.cayenne.DataObject

Constructor Summary

Method Summary

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

Methods inherited from class com.avoka.core.entity.BaseEntity

Methods inherited from class org.apache.cayenne.CayenneDataObject

Methods inherited from class org.apache.cayenne.BaseDataObject

Methods inherited from class org.apache.cayenne.PersistentObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.cayenne.Persistent

Field Detail

CLIENT_CODE_PROPERTY

CLIENT_NAME_PROPERTY

FORM_CODE_PROPERTY

FORM_NAME_PROPERTY

FORM_SERVER_NAME_PROPERTY

FORM_VERSION_NUMBER_PROPERTY

PORTAL_SERVER_NAME_PROPERTY

USER_AGENT_BROWSER_PROPERTY

USER_AGENT_OS_PROPERTY

USER_AGENT_BROWSER_TYPE_PROPERTY

USER_AGENT_BROWSER_VERSION_PROPERTY

USER_AGENT_OS_TYPE_PROPERTY

USER_AGENT_OS_VERSION_PROPERTY

MODE_FORM

MODE_RECEIPT

MODES

RECEIPT_MODE_WEB

RECEIPT_MODE_EMAIL

RECEIPT_MODE_DELIVERY

RECEIPT_MODES

Constructor Detail

RequestLog

Method Detail

getClientCode

getClientName

getFormCode

getFormName

getFormServerName

getFormVersionNumber

getPortalServerName

getUserAgentBrowserType

getUserAgentBrowserVersion

getUserAgentOsType

getUserAgentOsVersion

getUserAgentBrowser

getUserAgentOs

isFormRender

isReceiptRender

isLcFormsRequest

setLcFormsRequest

isLcDsigRequest

setLcDsigRequest

isLcReaderExtensionsRequest

setLcReaderExtensionsRequest