|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
The IPTState interface provides a means to pass in request-specific variables from the UI into the server. It is used to store and retrieve name-value pairs where names are strings, and values can be any type of object.
| Method Summary | |
void |
Add(java.lang.String bstrItemName,
byte[] Item,
int lSecs,
boolean bRefreshOnAccess)
Add an item to the state object. |
void |
Add(java.lang.String bstrItemName,
byte Item,
int lSecs,
boolean bRefreshOnAccess)
Add an item to the state object. |
void |
Add(java.lang.String bstrItemName,
double dItem,
int lSecs,
boolean bRefreshOnAccess)
Add an item to the state object. |
void |
Add(java.lang.String strItemName,
float fItem,
int lSecs,
boolean bRefreshOnAccess)
Add an item to the state object. |
void |
Add(java.lang.String strItemName,
int vItem,
int lSecs,
boolean bRefreshOnAccess)
Add an item to the state object. |
void |
Add(java.lang.String bstrItemName,
IPTState Item,
int lSecs,
boolean bRefreshOnAccess)
Add an item to the state object. |
void |
Add(java.lang.String bstrItemName,
java.lang.Object Item,
int lSecs,
boolean bRefreshOnAccess)
Add an item to the state object. |
void |
Add(java.lang.String strItemName,
java.lang.String strItem,
int lSecs,
boolean bRefreshOnAccess)
Add an item to the state object. |
void |
Add(java.lang.String strItemName,
com.plumtree.openfoundation.util.XPDateTime ptdtItem,
int lSecs,
boolean bRefreshOnAccess)
Add an item to the state object. |
void |
Clear()
Purges all items from the state object. |
boolean |
Exists(java.lang.String strItemName)
Checks whether an item of the specified name exists. |
byte |
GetAsByte(java.lang.String strItemName)
Retrieve an item from the state object. |
byte[] |
GetAsByte1DArray(java.lang.String strItemName)
Retrieve an item from the state object. |
double |
GetAsDouble(java.lang.String strItemName)
Retrieve an item from the state object. |
float |
GetAsFloat(java.lang.String strItemName)
Retrieve an item from the state object. |
int |
GetAsInt(java.lang.String strItemName)
Retrieve an item from the state object. |
IPTState |
GetAsIPTState(java.lang.String strItemName)
Retrieve an item from the state object. |
java.lang.Object |
GetAsObject(java.lang.String strItemName)
Retrieve an item from the state object. |
java.lang.String |
GetAsString(java.lang.String strItemName)
Retrieve an item from the state object. |
com.plumtree.openfoundation.util.XPDateTime |
GetAsXPDateTime(java.lang.String strItemName)
Retrieve an item from the state object. |
int |
GetCount()
Returns the number of items stored on the state object. |
com.plumtree.openfoundation.util.IXPEnumerator |
GetEnumerator()
Creates an enumerator that allows retrieving each item in the state object. |
void |
Remove(java.lang.String strItemName)
Remove an item from the state object. |
| Method Detail |
public void Add(java.lang.String strItemName,
int vItem,
int lSecs,
boolean bRefreshOnAccess)
strItemName - - The name of the item to add.nItem - - The value to add.lSecs - - The lifetime of the item, in seconds. If 0, the item never expires.bRefreshOnAccess - - Pass true to renew the lifetime of the item every time it
is accessed, otherwise false.
public void Add(java.lang.String strItemName,
java.lang.String strItem,
int lSecs,
boolean bRefreshOnAccess)
strItemName - - The name of the item to add.strItem - - The value to add.lSecs - - The lifetime of the item, in seconds. If 0, the item never expires.bRefreshOnAccess - - Pass true to renew the lifetime of the item every time it
is accessed, otherwise false.
public void Add(java.lang.String strItemName,
com.plumtree.openfoundation.util.XPDateTime ptdtItem,
int lSecs,
boolean bRefreshOnAccess)
strItemName - - The name of the item to add.ptdtItem - - The value to add.lSecs - - The lifetime of the item, in seconds. If 0, the item never expires.bRefreshOnAccess - - Pass true to renew the lifetime of the item every time it
is accessed, otherwise false.
public void Add(java.lang.String strItemName,
float fItem,
int lSecs,
boolean bRefreshOnAccess)
strItemName - - The name of the item to add.fItem - - The value to add.lSecs - - The lifetime of the item, in seconds. If 0, the item never expires.bRefreshOnAccess - - Pass true to renew the lifetime of the item every time it
is accessed, otherwise false.
public void Add(java.lang.String bstrItemName,
double dItem,
int lSecs,
boolean bRefreshOnAccess)
strItemName - - The name of the item to add.dItem - - The value to add.lSecs - - The lifetime of the item, in seconds. If 0, the item never expires.bRefreshOnAccess - - Pass true to renew the lifetime of the item every time it
is accessed, otherwise false.
public void Add(java.lang.String bstrItemName,
byte Item,
int lSecs,
boolean bRefreshOnAccess)
strItemName - - The name of the item to add.Item - - The value to add.lSecs - - The lifetime of the item, in seconds. If 0, the item never expires.bRefreshOnAccess - - Pass true to renew the lifetime of the item every time it
is accessed, otherwise false.
public void Add(java.lang.String bstrItemName,
IPTState Item,
int lSecs,
boolean bRefreshOnAccess)
strItemName - - The name of the item to add.Item - - The value to add.lSecs - - The lifetime of the item, in seconds. If 0, the item never expires.bRefreshOnAccess - - Pass true to renew the lifetime of the item every time it
is accessed, otherwise false.
public void Add(java.lang.String bstrItemName,
byte[] Item,
int lSecs,
boolean bRefreshOnAccess)
strItemName - - The name of the item to add.Item - - The value to add.lSecs - - The lifetime of the item, in seconds. If 0, the item never expires.bRefreshOnAccess - - Pass true to renew the lifetime of the item every time it
is accessed, otherwise false.
public void Add(java.lang.String bstrItemName,
java.lang.Object Item,
int lSecs,
boolean bRefreshOnAccess)
strItemName - - The name of the item to add.Item - - The value to add.lSecs - - The lifetime of the item, in seconds. If 0, the item never expires.bRefreshOnAccess - - Pass true to renew the lifetime of the item every time it
is accessed, otherwise false.public void Remove(java.lang.String strItemName)
strItemName - - The name of the item to remove.public int GetAsInt(java.lang.String strItemName)
strItemName - - The name of the item to retrieve.public java.lang.String GetAsString(java.lang.String strItemName)
strItemName - - The name of the item to retrieve.public com.plumtree.openfoundation.util.XPDateTime GetAsXPDateTime(java.lang.String strItemName)
strItemName - - The name of the item to retrieve.public float GetAsFloat(java.lang.String strItemName)
strItemName - - The name of the item to retrieve.public double GetAsDouble(java.lang.String strItemName)
strItemName - - The name of the item to retrieve.public byte GetAsByte(java.lang.String strItemName)
strItemName - - The name of the item to retrieve.public IPTState GetAsIPTState(java.lang.String strItemName)
strItemName - - The name of the item to retrieve.public byte[] GetAsByte1DArray(java.lang.String strItemName)
strItemName - - The name of the item to retrieve.public java.lang.Object GetAsObject(java.lang.String strItemName)
strItemName - - The name of the item to retrieve.public void Clear()
public com.plumtree.openfoundation.util.IXPEnumerator GetEnumerator()
public int GetCount()
public boolean Exists(java.lang.String strItemName)
strItemName - - The name of the item to search for.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||