com.ptc.netmarkets.util.misc
Class NmContext

java.lang.Object
  extended by com.ptc.netmarkets.util.misc.NmContext
All Implemented Interfaces:
Externalizable, Serializable

public class NmContext
extends Object
implements Externalizable



Supported API: true

Extendable: true

See Also:
Serialized Form

Method Summary
static NmContext fromString(String str)
          Creates a new NmContext from a String

Supported API: true
 Stack getContextItems()
          Gets the value of the attribute: contextItems.
 NmOid getPageOid()
          Returns the object that is the last in context chain.
 NmOid getPrimaryOid()
          Returns the object that is the first in context chain.
 NmOid getTargetOid()
          The object being acted on.
 void popElement()
          

Supported API: true
 void popFormElement()
          

Supported API: true
 void popTreeElement()
          

Supported API: true
 void pushElement(com.ptc.netmarkets.model.NmObject object)
          

Supported API: true
 void pushFormElement(String name)
          

Supported API: true
 void pushTreeElement(com.ptc.netmarkets.util.treetable.NmHTMLTreeNode node)
          

Supported API: true
 String toString()
          

Supported API: true
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getContextItems

public Stack getContextItems()
Gets the value of the attribute: contextItems.

Supported API: true

Returns:
Stack

toString

public String toString()


Supported API: true

Overrides:
toString in class Object
Returns:
String

fromString

public static NmContext fromString(String str)
                            throws WTException
Creates a new NmContext from a String

Supported API: true

Parameters:
str -
Returns:
NmContext
Throws:
WTException

getPrimaryOid

public NmOid getPrimaryOid()
                    throws WTException
Returns the object that is the first in context chain. The first oid in the Nmcontext String

Supported API: true

Returns:
NmOid
Throws:
WTException

getPageOid

public NmOid getPageOid()
                 throws WTException
Returns the object that is the last in context chain. The last oid in the Nmcontext String. Which is the oid of the last include of a jsp

Supported API: true

Returns:
NmOid
Throws:
WTException

getTargetOid

public NmOid getTargetOid()
                   throws WTException
The object being acted on. Returns the object that is the last in the element address chain for the last object in the context chain.

Supported API: true

Returns:
NmOid
Throws:
WTException

pushElement

public void pushElement(com.ptc.netmarkets.model.NmObject object)


Supported API: true

Parameters:
object -

popElement

public void popElement()


Supported API: true


pushFormElement

public void pushFormElement(String name)


Supported API: true

Parameters:
name -

popFormElement

public void popFormElement()


Supported API: true


pushTreeElement

public void pushTreeElement(com.ptc.netmarkets.util.treetable.NmHTMLTreeNode node)


Supported API: true

Parameters:
node -

popTreeElement

public void popTreeElement()


Supported API: true