net.sf.jeters.componentInterface
Interface InputComponent_Series<T extends net.sf.jeters.componentInterface.editables.EditableText>

All Superinterfaces:
Component, InputComponent<T>
All Known Implementing Classes:
MediaWikiIO

public interface InputComponent_Series<T extends net.sf.jeters.componentInterface.editables.EditableText>
extends InputComponent<T>

optional interface for JETERS-Input-components.

Input-Components implementing this interface don't load only one text for editing (at least in most cases), but a series of texts matching certain criteria. Obviously, this is a specialization of the plain InputComponent interface.

Version:
[development]
Author:
Tobias Knerr

Method Summary
 T getInput(UIComponent uiForRequests)
          receive a text that can be edited by the program; the next call to getInput is expected to return another text if seriesComplete() returns false
 boolean hasNext()
          indicates if there are still texts left for editing
 

Method Detail

getInput

T getInput(UIComponent uiForRequests)
receive a text that can be edited by the program; the next call to getInput is expected to return another text if seriesComplete() returns false

Specified by:
getInput in interface InputComponent<T extends net.sf.jeters.componentInterface.editables.EditableText>
Parameters:
uiForRequests - UI-component for communication with the user (if necessary)
Returns:
the text for editing, is allowed to be null in cases where loading fails for some reason

hasNext

boolean hasNext()
indicates if there are still texts left for editing

Returns:
false if all texts which are part of the series have already been returned by getInput, otherwise true