planetj.dataengine
Interface INavigationObject

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:

AbstractContext, LayoutDisplayPropertyGroup, Row, RowCollection

public interface INavigationObject

extends java.lang.Cloneable, java.io.Serializable

Method Summary

java.lang.Object	clone() Clone this navigation object.
java.lang.String	getNavigationKey() Get the key used to store and retrieve this object to and from navigation.
java.lang.String	getNavigationListKey() Get the key used to store and retrieve a List of all the navigation keys for any navigation object put into navigation with the same List key.
boolean	isCloneNeeded() Test to see if tiis navigation object should be clone upon storing and retrieving.
void	removeNavigationKey() Clears out any navigation key that may have been set on this object.
void	setNavigationKey(java.lang.String key) Set the key used to store and retrieve this object to and from navigation.

Method Detail

clone

public java.lang.Object clone()

Clone this navigation object.

getNavigationKey

public java.lang.String getNavigationKey()

Get the key used to store and retrieve this object to and from navigation.

getNavigationListKey

public java.lang.String getNavigationListKey()

Get the key used to store and retrieve a List of all the navigation keys for any navigation object put into navigation with the same List key. Provides a way to group similar objects within navigation.

isCloneNeeded

public boolean isCloneNeeded()

Test to see if tiis navigation object should be clone upon storing and retrieving.

removeNavigationKey

public void removeNavigationKey()

Clears out any navigation key that may have been set on this object.

setNavigationKey

public void setNavigationKey(java.lang.String key)

Set the key used to store and retrieve this object to and from navigation.