com.plumtree.openfoundation.web
Interface IXPSession

All Known Implementing Classes:
XPSession

public interface IXPSession

This interface provides basis for client Session and procides accessor methods for setting and getting various session attributes, when implemented.


Method Summary
 void Abandon()
          Invalidates this session then unbinds any objects bound to it.
 java.lang.Object GetAttribute(java.lang.String name)
          Returns the object bound with the specified name in this session, or null if no object is bound under the name.
 void RemoveAttribute(java.lang.String name)
          Removes the object bound with the specified name from this session.
 void SetAttribute(java.lang.String name, java.lang.Object _value)
          Binds an object to this session, using the name specified.
 

Method Detail

GetAttribute

public java.lang.Object GetAttribute(java.lang.String name)
Returns the object bound with the specified name in this session, or null if no object is bound under the name.

Parameters:
name - - a string specifying the name of the object
Returns:
the object with the specified name

SetAttribute

public void SetAttribute(java.lang.String name,
                         java.lang.Object _value)
Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

Parameters:
name - - the name to which the object is bound; cannot be null
_value - - the object to be bound

RemoveAttribute

public void RemoveAttribute(java.lang.String name)
Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.

Parameters:
name - - the name of the object to remove from this session

Abandon

public void Abandon()
Invalidates this session then unbinds any objects bound to it.



Copyright 2002, 2003, 2004 Plumtree Software Inc. All Rights Reserved.