com.ptc.netmarkets.util.beans
Class NmSessionBean

java.lang.Object
  com.ptc.netmarkets.util.beans.NmSessionBean

All Implemented Interfaces:

Externalizable, Serializable

public class NmSessionBean
extends Object
implements Externalizable

Supported API: true

Extendable: true

See Also:

Serialized Form

Method Summary

void	addExpandedNode(NmCommandBean cb, String context, String anode) adds an expanded node to the context of the tree Supported API: true
void	clearDynamicAtts() clears out all session info about dynamic info Supported API: true
String	getDynamicAction() Reads the dynamic action from the session bean storage.
ArrayList	getDynamicContexts() Reads the dynamic oid list from the session bean storage.
ArrayList	getDynamicLocationContexts() Reads the dynamic oid list from the session bean storage.
ArrayList	getDynamicLocations() Reads the dynamic oid list from the session bean storage.
ArrayList	getDynamicOids() Reads the dynamic oid list from the session bean storage.
Set	getExpandedNodes(NmCommandBean cb, String context) gets expanded node list of the tree context
int	getLimit() The number of rows per page in a table the user has specified Supported API: true
ConcurrentHashMap	getStorage() Gets the value of the attribute: storage; Session wide storage for use by application developers.
boolean	isCAD() Deprecated. see isCad
boolean	isDynamic() This is an extra parameter the user can set that allows you to set an extra check to determine if a method is dynamic.
void	removeAllNodes(NmCommandBean cb, String context) removes all nodes of the tree context
void	removeExpandedNode(NmCommandBean cb, String context, String anode) removes an expanded node from the context of the tree Supported API: true
void	setCAD(boolean a_CAD) Deprecated. see isCad

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getStorage

public ConcurrentHashMap getStorage()

Gets the value of the attribute: storage; Session wide storage for use by application developers.

Supported API: true

Returns:

ConcurrentHashMap

getLimit

public int getLimit()

The number of rows per page in a table the user has specified

Supported API: true

getDynamicOids

public ArrayList getDynamicOids()

Reads the dynamic oid list from the session bean storage. If you are in a JSP or table renderer this is how you would find the list of oids.

Returns:

NmOid

Supported API: true

getDynamicContexts

public ArrayList getDynamicContexts()

Reads the dynamic oid list from the session bean storage. If you are in a JSP or table renderer this is how you would find the list of contexts.

Returns:

NmOid

Supported API: true

getDynamicLocationContexts

public ArrayList getDynamicLocationContexts()

Reads the dynamic oid list from the session bean storage. If you are in a JSP or table renderer this is how you would find the list of location contexts.

Returns:

NmOid

Supported API: true

getDynamicLocations

public ArrayList getDynamicLocations()

Reads the dynamic oid list from the session bean storage. If you are in a JSP or table renderer this is how you would find the list of oids.

Returns:

NmOid

Supported API: true

getDynamicAction

public String getDynamicAction()

Reads the dynamic action from the session bean storage. If you are in a JSP or table renderer this is where you would find the action. The action constants can be found in NmCommandBean. They include: DYNAMIC_ADD, DYNAMIC_UPD, and DYNAMIC_EXPAND.

Returns:

String

Supported API: true

isDynamic

public boolean isDynamic()

This is an extra parameter the user can set that allows you to set an extra check to determine if a method is dynamic. This is here in case the object you are adding does not have an oid, or if the method fails you can set this so it does not try to re-attempt the dynamic action.

Returns:

boolean

Supported API: true

clearDynamicAtts

public void clearDynamicAtts()

clears out all session info about dynamic info

Supported API: true

isCAD

public boolean isCAD()

Deprecated. see isCad

Gets the value of the attribute: CAD; determines if client should see cad only actions

Supported API: true

Returns:

boolean

setCAD

public void setCAD(boolean a_CAD)

Deprecated. see isCad

Sets the value of the attribute: CAD; determines if client should see cad only actions

Supported API: true

Parameters:

a_CAD -

addExpandedNode

public void addExpandedNode(NmCommandBean cb,
                            String context,
                            String anode)

adds an expanded node to the context of the tree

Supported API: true

removeExpandedNode

public void removeExpandedNode(NmCommandBean cb,
                               String context,
                               String anode)

removes an expanded node from the context of the tree

Supported API: true

getExpandedNodes

public Set getExpandedNodes(NmCommandBean cb,
                            String context)

gets expanded node list of the tree context

Parameters:

context - - context of the tree

Supported API: true

removeAllNodes

public void removeAllNodes(NmCommandBean cb,
                           String context)

removes all nodes of the tree context

Parameters:

context - - context of the tree

Supported API: true