net.sourceforge.mflow.api
Interface ReceiveFolder

All Superinterfaces:

Configurable, Iconable, MsgFlowComponent, MsgFolder, MsgReceiver

public interface ReceiveFolder

extends MsgFolder, MsgReceiver

Interface for incoming Msg folders

Version:

$Revision: 1.4 $

Author:

David Carr

Method Summary

void	addChild(MsgFolder child) Adds a child folder
MsgFolder[]	getChild() Accessor for all the children of this folder
MsgFolder	getChild(int index) Accessor for a single child folder
void	removeChild(MsgFolder child) Removes a child folder
void	setChild(int index, MsgFolder child) Mutator for a single child folder
void	setChild(MsgFolder[] children) Mutator for all the children of this folder

Methods inherited from interface net.sourceforge.mflow.api.MsgFolder

addMsg, addMsgChangeListener, getMsg, getMsg, getMsgChangeListeners, getNewMsgCount, getParent, getUnreadMsgCount, isRootFolder, removeMsg, removeMsgChangeListener, setMsg, setMsg, setMsgChangeListeners, setParent

Methods inherited from interface net.sourceforge.mflow.api.MsgFlowComponent

getName, setName

Methods inherited from interface net.sourceforge.mflow.api.Configurable

configure

Methods inherited from interface net.sourceforge.mflow.api.Iconable

getIcon

Methods inherited from interface net.sourceforge.mflow.api.MsgReceiver

putMsg

Methods inherited from interface net.sourceforge.mflow.api.MsgFlowComponent

getName, setName

Methods inherited from interface net.sourceforge.mflow.api.Configurable

configure

Methods inherited from interface net.sourceforge.mflow.api.Iconable

getIcon

Method Detail

addChild

void addChild(MsgFolder child)

Adds a child folder

Parameters:

child - the folder to add as a child

removeChild

void removeChild(MsgFolder child)

Removes a child folder

Parameters:

child - the folder to remove as a child

getChild

MsgFolder[] getChild()

Accessor for all the children of this folder

Returns:

an array of MsgFolders

setChild

void setChild(MsgFolder[] children)

Mutator for all the children of this folder

Parameters:

children - an array of the new MsgFolders to be children of this folder

getChild

MsgFolder getChild(int index)

Accessor for a single child folder

Parameters:

index - the index of the folder

Returns:

the folder at the specified index

setChild

void setChild(int index,
              MsgFolder child)

Mutator for a single child folder

Parameters:

index - the index

child - the folder to set at the specified index