net.sourceforge.chessshell.plugin.api

Interface IFolderManager

public interface IFolderManager

Generic manager of a folder hierarchy.

Method Summary

Modifier and Type	Method and Description
boolean	addNewFolder(java.lang.String name) Add folder at the current path location.
void	addNewItem(FolderItem item) Add new item at the current path location.
void	close()
void	deleteFolder(int i) Delete i'th folder at the current path location.
void	deleteItem(int i) Delete i'th item at the current path location.
void	deleteItemByContentIndex(long itemIndex) Delete item with the given CONTENT index (!), also decrementing index of items with higher index than the given one.
FolderPath	getCurrentPath()
int	getFolderCount()
java.lang.String	getFolderName(int i)
FolderItem	getItem(int i)
int	getItemCount()
boolean	hasParentFolder()
void	selectFolderByIndex(int i) Navigate to the i'th folder from current path location.
void	selectParentFolder() Navigate to parent folder, if it exists.
void	selectRootFolder() Navigate to root folder.

Method Detail

getCurrentPath

FolderPath getCurrentPath()

Returns:

the current path.

close

void close()
    throws net.sourceforge.chessshell.common.DatabaseException

Throws:

net.sourceforge.chessshell.common.DatabaseException

addNewFolder

boolean addNewFolder(java.lang.String name)
              throws net.sourceforge.chessshell.common.DatabaseException

Add folder at the current path location.

Parameters:

name -

Returns:

false if folder with that name already exists.

Throws:

net.sourceforge.chessshell.common.DatabaseException

addNewItem

void addNewItem(FolderItem item)
         throws net.sourceforge.chessshell.common.DatabaseException

Add new item at the current path location.

Parameters:

itemIndex -

item -

Throws:

net.sourceforge.chessshell.common.DatabaseException

deleteFolder

void deleteFolder(int i)
           throws net.sourceforge.chessshell.common.DatabaseException

Delete i'th folder at the current path location.

Parameters:

i -

Throws:

net.sourceforge.chessshell.common.DatabaseException

deleteItem

void deleteItem(int i)
         throws net.sourceforge.chessshell.common.DatabaseException

Delete i'th item at the current path location.

Parameters:

i -

Throws:

net.sourceforge.chessshell.common.DatabaseException

getFolderCount

int getFolderCount()
            throws net.sourceforge.chessshell.common.DatabaseException

Returns:

number of folders at the current location.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getFolderName

java.lang.String getFolderName(int i)
                        throws net.sourceforge.chessshell.common.DatabaseException

Returns:

name of the i'th folder at the current path location.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getItemCount

int getItemCount()
          throws net.sourceforge.chessshell.common.DatabaseException

Returns:

number of items at the current location.

Throws:

net.sourceforge.chessshell.common.DatabaseException

getItem

FolderItem getItem(int i)
            throws net.sourceforge.chessshell.common.DatabaseException

Parameters:

i -

Returns:

the i'th item at the current location.

Throws:

net.sourceforge.chessshell.common.DatabaseException

selectFolderByIndex

void selectFolderByIndex(int i)
                  throws net.sourceforge.chessshell.common.DatabaseException

Navigate to the i'th folder from current path location.

Throws:

net.sourceforge.chessshell.common.DatabaseException

hasParentFolder

boolean hasParentFolder()

Returns:

Does parent folder exist ?

See Also:

selectParentFolder()

selectParentFolder

void selectParentFolder()
                 throws net.sourceforge.chessshell.common.DatabaseException

Navigate to parent folder, if it exists.

Throws:

net.sourceforge.chessshell.common.DatabaseException

See Also:

hasParentFolder()

selectRootFolder

void selectRootFolder()
               throws net.sourceforge.chessshell.common.DatabaseException

Navigate to root folder.

Throws:

net.sourceforge.chessshell.common.DatabaseException

deleteItemByContentIndex

void deleteItemByContentIndex(long itemIndex)
                       throws net.sourceforge.chessshell.common.DatabaseException

Delete item with the given CONTENT index (!), also decrementing index of items with higher index than the given one. This behavior caters for a 'compacting-operation' of the content database, in which items are deleted physically (and items with higher indices then get their index decremented).

Parameters:

itemIndex -

Throws:

net.sourceforge.chessshell.common.DatabaseException