org.palo.api.ext.favoriteviews
Interface FavoriteViewsFolder

All Superinterfaces:
FavoriteViewObject, NamedEntity
All Known Implementing Classes:
FavoriteViewsFolderImpl

public interface FavoriteViewsFolder
extends FavoriteViewObject

A FavoriteViewsFolder is an object has a name and a position and can be added to a FavoriteViewTree. It acts as a container for FavoriteViews. Please note that favorite views are saved for each connection, so each favorite view can represent a view from any database of that connection. Thus, the same is true for the FavoriteViewsFolder; it is always bound to exactly one Connection object. In order to create a FavoriteViewsFolder object, please use the FavoriteViewFactory. In order to create a new favorite views folder with the name TestFolder in the connection con, you would use: FavoriteViewsFolder folder = FavoriteViewFactory.getInstance(). createFavoriteView("TestFolder", con); When creating the folder, you can also specify an optional third argument giving the position of the new folder realtive to its parent. For example, if the parent of the folder (which, again, is a favorite view folder) has five children, you can insert a new folder at any position from 0 to 5 (sic!). The new child will be inserted after the specified number and thus, "5" is valid in this case to append the new folder at the end of its parent's children.

Version:
$Id: FavoriteViewsFolder.html,v 1.10 2009/07/09 11:01:47 ArndHouben Exp $

Method Summary
 int getPosition()
          Returns the position of the folder.
 void setName(java.lang.String newName)
          Sets a new name for the folder.
 void setPosition(int newPosition)
          Sets a new position for the folder.
 
Methods inherited from interface org.palo.api.ext.favoriteviews.FavoriteViewObject
getConnection
 
Methods inherited from interface org.palo.api.NamedEntity
getName
 

Method Detail

setName

void setName(java.lang.String newName)
Sets a new name for the folder.

Parameters:
newName - the new name for the folder.

getPosition

int getPosition()
Returns the position of the folder.

Returns:
the position of this favorite views folder in relation to its parent.

setPosition

void setPosition(int newPosition)
Sets a new position for the folder.

Parameters:
newPosition - the new position for the folder.