com.plumtree.server
Interface IPTStates

public interface IPTStates

This interface is a container for managing a collection of IPTState objects.

Version:

2.0

Author:

Arvind Seshan

Method Summary

void	Add(int lMode, IPTState pState) Add an IPTState object to the collection.
IPTState	Get(int lMode) Retrieve an IPTState object from the collection.
void	Remove(int lMode) Remove an IPTState object from the collection.

Method Detail

Add

void Add(int lMode,
         IPTState pState)

Add an IPTState object to the collection. At most one IPTState object can be stored per mode (Application-level state, Session-level state, Request-level state).

Parameters:

lMode - - The mode to associate with the IPTState object. Valid values are from the PT_STATEMODES enumeration: PT_STATEMODES.PT_STATEMODES_APPLICATION for application-level state PT_STATEMODES.PT_STATEMODES_SESSION for user session-level state PT_STATEMODES.PT_STATEMODES_REQUEST for request-level state

pState - - The IPTState object to add to the collection.

Remove

void Remove(int lMode)

Remove an IPTState object from the collection.

Parameters:

lMode - - The mode of the IPTState object to remove.

Get

IPTState Get(int lMode)

Retrieve an IPTState object from the collection.

Parameters:

lMode - - The mode of the IPTState object to retrieve.

Returns:

IPTState