|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.6.0) E10684-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.view.rich.monitoring.UserActivityInfo
public final class UserActivityInfo
The UserActivityInfo class holds information pertaining to a user action. This class is used for the purposes of monitoring end user activity such as start and end time for a user action initiated from the client-side.
Nested Class Summary | |
---|---|
static class |
UserActivityInfo.ErrorInfo Represents an error object for an error that caused the request to fail. |
static class |
UserActivityInfo.EventInfo Represents a primary event that triggered the request. |
Field Summary | |
---|---|
static java.lang.String |
CURR_KEY * Used to locate the UserActivityInfo for the curent request. |
static java.lang.String |
PREV_KEY Used to locate the UserActivityInfo for the previous request. |
static java.lang.String |
USER_ACTIVITY_INFO_REQ_PARAM Used to store the user activity information in the requestMap |
Constructor Summary | |
---|---|
UserActivityInfo(java.lang.String contextId, java.lang.String parentContextId, java.lang.String clientStartTime, java.lang.String clientEndTime) Creates a user activity record for the request identified by the provided contextId. |
|
UserActivityInfo(java.lang.String viewId, java.lang.String windowId, UserActivityInfo.EventInfo eventInfo, java.lang.String clientStartTime, java.util.List<UserActivityInfo.ErrorInfo> errors, java.util.List<java.lang.String> partialTargets) Creates a user activity record for the current context. |
Method Summary | |
---|---|
java.lang.String |
getClientEndTime() Gets the client end time. |
java.lang.String |
getClientStartTime() Gets the client start time. |
java.lang.String |
getContextId() Gets the context identifier. |
java.util.List<UserActivityInfo.ErrorInfo> |
getErrors() A list of ErrorInfo objects, representing the errors that caused the request to fail. |
UserActivityInfo.EventInfo |
getEventInfo() Gets the EventInfo object that contains the event info of the event that triggered this request. |
java.lang.String |
getParentContextId() Gets the parent's context identifier. |
java.util.List<java.lang.String> |
getPartialTargets() A list of client component ids of components that are registered as partial targets for the request. |
static java.lang.String |
getPreviousKeyInSequence(int sequence) Gets the previous key to use for the specified sequence number. |
java.lang.String |
getViewId() The viewId for the request. |
java.lang.String |
getWindowId() The windowId of the window that initiated the request. |
void |
setErrors(java.util.List<UserActivityInfo.ErrorInfo> errors) Sets a list of ErrorInfo objects on the UserActivityInfo instance pertaining to the current request. |
void |
setEventInfo(UserActivityInfo.EventInfo eventInfo) Sets the event information (typically) on the UserActivityInfo instance pertaining to the current request. |
void |
setPartialTargets(java.util.List<java.lang.String> partialTargets) Sets the list of partial targets on the UserActivityInfo instance pertaining to the current request. |
void |
setViewId(java.lang.String viewId) Sets the viewId on the UserActivityInfo instance pertaining to the current request. |
void |
setWindowId(java.lang.String windowId) Sets the windowId on the UserActivityInfo instance pertaining to the current request. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String USER_ACTIVITY_INFO_REQ_PARAM
public static final java.lang.String PREV_KEY
public static final java.lang.String CURR_KEY
Constructor Detail |
---|
public UserActivityInfo(java.lang.String contextId, java.lang.String parentContextId, java.lang.String clientStartTime, java.lang.String clientEndTime)
contextId
- the String context identifier for a primary request or a secondary request. This is a required parameter and a warnign is logged if null.parentContextId
- the String identifier of the ExecutionContext associated with the parent request. This is typically passed in for child (secondary) requests of a primary. This can be null when called for a primary request.clientStartTime
- start time of the client request in UTC using the client's clock. For the page 0 request, client start time will be the "approximate start time", iow, the start time is clocked when the page is about to load on the client rather than the start time when the initial page 0 request was received on the server. This is a required parameter and a warning is logged if null.clientEndTime
- the end time of the user action. Can be null for the current request as it's currently being serviced.public UserActivityInfo(java.lang.String viewId, java.lang.String windowId, UserActivityInfo.EventInfo eventInfo, java.lang.String clientStartTime, java.util.List<UserActivityInfo.ErrorInfo> errors, java.util.List<java.lang.String> partialTargets)
viewId
- the current viewId, this cannot be null.windowId
- the current windowId ((to distinguish results from multiple windows in the same session). This can not be null.eventInfo
- information pertaining to the primary event that caused this server request. If an attribute change caused this request, we may not have an event. But we will certainly have a pprTargets. This can be null in cases where attribute changes caused a partial request.clientStartTime
- start time of the client request in UTC using the client's clock. Usually cannot be null but for the page 0 request, client start time will be null. Also due to the page-0 problem start time will have approximate value.errors
- errors captured on the client, for the current request. If there were no errors this would be null. Server errors get logged as and when they occur.partialTargets
- a list of component ids that have registered as partial targets (on the client) for the current request. If there are no partial targets, this will be null.Method Detail |
---|
public java.lang.String getContextId()
public java.lang.String getParentContextId()
getContextId()
).public java.lang.String getClientStartTime()
public java.lang.String getClientEndTime()
public UserActivityInfo.EventInfo getEventInfo()
public java.util.List<UserActivityInfo.ErrorInfo> getErrors()
public static java.lang.String getPreviousKeyInSequence(int sequence)
sequence
- the int ffor which to generate the keypublic java.lang.String getViewId()
public java.lang.String getWindowId()
public java.util.List<java.lang.String> getPartialTargets()
public void setEventInfo(UserActivityInfo.EventInfo eventInfo)
eventInfo
- an EventInfo objectpublic void setErrors(java.util.List<UserActivityInfo.ErrorInfo> errors)
errors
- List of ErrorInfo objectspublic void setPartialTargets(java.util.List<java.lang.String> partialTargets)
partialTargets
- a List of partial targets.public void setViewId(java.lang.String viewId)
viewId
- the viewId.public void setWindowId(java.lang.String windowId)
windowId
- the windowId for the current window.
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.6.0) E10684-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |