ClientRequestContext (Oracle Team Productivity Center)

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center
11g Release 2 (11.1.2.2.0)
E17494-03

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.alm.common
Class ClientRequestContext

java.lang.Object oracle.alm.common.ClientRequestContext

public class ClientRequestContext

extends java.lang.Object

AlmClientRequestContext is the class representing a TPC client request. It is initialized by TPC client representing the current client request. TPC connector writer can utilize it to log a message that can display to TPC client end user in the connector code

 AlmClientContext.addClientMessage(session,
                                   AlmMessage.SEVERITY_ERROR,
                                   "Invalid Input",
                                  "The provided value on due date is not correct. Please use correct format.");

Since:: 11.1.1.1.0

Field Summary
`static java.lang.String`	`CLIENT_REQUEST_SESSION_ID`

Constructor Summary
`ClientRequestContext(java.lang.String clientRequestId)` Construct to create an ClientRequestContext instance

Method Summary
`static void`	`addClientMessage(java.util.Map sessionContext, AlmMessage.Severity severity, java.lang.String title, java.lang.String msg)` Utility API for adding a AlmMessage to show to end user through TPC IDE client.
`java.lang.String`	`getRequestId()` Return the requestId (which uniquely identify the current request).

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

CLIENT_REQUEST_SESSION_ID

public static final java.lang.String CLIENT_REQUEST_SESSION_ID

See Also:: Constant Field Values

Constructor Detail

ClientRequestContext

public ClientRequestContext(java.lang.String clientRequestId)

Construct to create an ClientRequestContext instance

Parameters:: clientRequestId -

Method Detail

getRequestId

public java.lang.String getRequestId()

Return the requestId (which uniquely identify the current request).

Returns:: the request ID as a String.

addClientMessage

public static void addClientMessage(java.util.Map sessionContext,
                                    AlmMessage.Severity severity,
                                    java.lang.String title,
                                    java.lang.String msg)

Utility API for adding a AlmMessage to show to end user through TPC IDE client.

Parameters:: sessionContext -; severity -; title -; msg -