|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.runtime.IOGV
public class IOGV
IOGV is a convenience class that contains synchronized static methods for interacting with Global Variables.
It was specifcally designed to do this interaction for the benefit of Integration Objects (IOs) for input
and output pages. Note that this is for accessing only shared Global Variables.
| Field Summary | |
|---|---|
static String |
HATSGV
The HttpServletRequest parameter value identifier |
| Constructor Summary | |
|---|---|
IOGV()
|
|
| Method Summary | |
|---|---|
static IGlobalVariable |
getGlobalVariable(javax.servlet.http.HttpSession httpSession,
String name)
Deprecated. Use getGlobalVariable(ISession, String) instead. |
static IGlobalVariable |
getGlobalVariable(ISession iSession,
String name)
This method returns the specified shared Global Variable from the specified client session. This method will not execute if the objects passed in are null, or the iSession is not a valid client identifier. |
static IGlobalVariable |
getGlobalVariable(String id,
String name)
This method allows direct access to the shared Global Variable. |
static int |
getGlobalVariableLength(String id,
String name)
This method returns the integer (int) value of the length of an indexed shared Global Variable. |
static String |
getGlobalVariableString(String id,
String name)
This method returns the String value of a shared Global Variable. |
static String |
getGlobalVariableString(String id,
String name,
int i)
This method returns the String value of an indexed shared Global Variable. |
static void |
process(javax.servlet.http.HttpServletRequest req)
Deprecated. Use process(IRequest) instead. |
static void |
process(IRequest req)
When the input page is generated for an IO, the parameters matching to Global Variables are added as hidden input fields. Specifically, the hidden input fields have a name matching the value of HATSGV and a value of the name of the Global Variable. There are input fields in the input IO page that have the same name as the global variable and a value. When the input page is submitted to the output IO page, this data becomes IRequest parameters. |
static void |
removeGlobalVariable(ISession iSession,
IGlobalVariable igv)
This method removes a shared Global Variable from a client session. This method will not execute if the objects passed in are null, or the iSession is not a valid client identifier. This method does nothing if the specified shared Global Variable does not exist. |
static void |
removeGlobalVariable(ISession iSession,
String gvName)
This method removes a non-indexed shared Global Variable from a client session. This method will not execute if the objects passed in are null, or the iSession is not a valid client identifier. This method does nothing if the specified shared Global Variable name does not exist. |
static void |
setGlobalVariable(javax.servlet.http.HttpSession httpSession,
IGlobalVariable igv)
Deprecated. Use setGlobalVariable(ISession, IGlobalVariable) instead. |
static void |
setGlobalVariable(ISession iSession,
IGlobalVariable igv)
This method allows addition of a shared Global Variable to a client session. |
static void |
setGlobalVariable(String id,
IGlobalVariable igv)
This method allows addition of a shared Global Variable to a client session. This method will not execute if the objects passed in are null, or the id String is not a valid client identifier. |
static void |
setGlobalVariableString(javax.servlet.http.HttpSession httpSession,
String gvName,
String gvValue)
Deprecated. Use setGlobalVariableString(ISession, String, String) instead. |
static void |
setGlobalVariableString(ISession iSession,
String name,
String value)
This method adds the specified shared Global Variable name/value pair to the specified client session. This method will not execute if the objects passed in are null, or the iSession is not a valid client identifier. |
static void |
setGlobalVariableString(String id,
String gvName,
String gvValue)
This method allows addition of a non-indexed shared Global Variable to a client session. This method will not execute if the objects passed in are null, or the id String is not a valid client identifier. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String HATSGV
| Constructor Detail |
|---|
public IOGV()
| Method Detail |
|---|
public static String getGlobalVariableString(String id,
String name)
id - typically the HttpSession.getId() or whatever identifier string was used in creating the clientname - String name of the shared Global Variable
public static String getGlobalVariableString(String id,
String name,
int i)
id - String typically HttpSession.getId() or whatever identifier string was used in creating the clientname - String name of the shared Global Variablei - index within the shared Global Variable of the String to return
public static int getGlobalVariableLength(String id,
String name)
id - typically HttpSession.getId() or whatever identifier string was used in creating the clientname - name of the shared Global Variable
public static IGlobalVariable getGlobalVariable(javax.servlet.http.HttpSession httpSession,
String name)
httpSession - HttpSessionname - name of the shared Global Variable
public static IGlobalVariable getGlobalVariable(String id,
String name)
id - typically the HttpSession.getId() or whatever identifier string was used in creating the clientname - name of the shared Global Variable
public static void setGlobalVariable(javax.servlet.http.HttpSession httpSession,
IGlobalVariable igv)
httpSession - the HttpSessionigv - the new IGlobalVariable object
public static void setGlobalVariable(String id,
IGlobalVariable igv)
id - typically the HttpSession.getId() or whatever identifier string was used in creating the clientigv - the new IGlobalVariable object
public static void setGlobalVariableString(javax.servlet.http.HttpSession httpSession,
String gvName,
String gvValue)
httpSession - HttpSessiongvName - the new shared Global Variable namegvValue - the new shared Global Variable value
public static void setGlobalVariableString(String id,
String gvName,
String gvValue)
id - String typically HttpSession.getId() or whatever identifier string was used in creating the clientgvName - the new shared Global Variable namegvValue - the new shared Global Variable valuepublic static void process(javax.servlet.http.HttpServletRequest req)
req - The HTTP request object containing the HATSGV parameter values.public static void process(IRequest req)
req - The IRequest object containing the HATSGV parameter values.
public static void removeGlobalVariable(ISession iSession,
IGlobalVariable igv)
iSession - the session containing the Global Variable to be removedigv - the IGlobalVariable to remove
public static void removeGlobalVariable(ISession iSession,
String gvName)
iSession - the ISession containing the Global Variable to be removedgvName - the name of the Global Variable to remove
public static IGlobalVariable getGlobalVariable(ISession iSession,
String name)
iSession - the ISession containing the Global Variablename - the name of the IGlobalVariable to return
public static void setGlobalVariableString(ISession iSession,
String name,
String value)
iSession - the ISession to add the Global Variable toname - the name of the IGlobalVariable to addvalue - the value of the Global Variable being added
public static void setGlobalVariable(ISession iSession,
IGlobalVariable igv)
iSession - the ISession to add the Global Variable toigv - the new IGlobalVariable object
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||