com.ibm.rational.rpe.api.docgen
Interface IDocumentGenerator

All Superinterfaces:
IControl
All Known Implementing Classes:
LocalDocumentGenerator, RemoteDocumentGenerator

public interface IDocumentGenerator
extends IControl

The interface for configuring, starting, and controlling document generations.


Method Summary
 void enableDebug(boolean debug)
          Enables the core debug mode for the document generation
 java.util.List<RPEResult> getResults()
          Returns the list of results produced by the document generation process.
 com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus getStatus()
          Returns the status of the generation
 java.lang.Thread publish(RPEDocumentSpecification docSpec, int previewQueryLimit)
          Publishes the document asynchronously.
 com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus publishSync(RPEDocumentSpecification docspec, int previewQueryLimit)
          Publishes the document asynchronously.
 void registerListener(RPEListener listener)
          Registers a RPE listener to receive progress messages about the document generation
 void unregisterListener(RPEListener listener)
          Unregisters the listener from the generator
 
Methods inherited from interface com.ibm.rational.rpe.engine.IControl
pause, resume, stop
 

Method Detail

registerListener

void registerListener(RPEListener listener)
Registers a RPE listener to receive progress messages about the document generation

Parameters:
listener -

unregisterListener

void unregisterListener(RPEListener listener)
Unregisters the listener from the generator

Parameters:
listener -

enableDebug

void enableDebug(boolean debug)
Enables the core debug mode for the document generation

Parameters:
debug -

publish

java.lang.Thread publish(RPEDocumentSpecification docSpec,
                         int previewQueryLimit)
                         throws RPEException
Publishes the document asynchronously. Note that the document generation is not finished when this method returns.

Parameters:
docSpec -
previewQueryLimit -
Returns:
Throws:
RPEException

publishSync

com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus publishSync(RPEDocumentSpecification docspec,
                                                                int previewQueryLimit)
                                                                throws RPEException
Publishes the document asynchronously. The document generations is finished when this method returns.

Parameters:
docspec -
previewQueryLimit -
Returns:
Throws:
RPEException

getResults

java.util.List<RPEResult> getResults()
Returns the list of results produced by the document generation process. If the generation failed, then the list is empty.

Returns:

getStatus

com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus getStatus()
Returns the status of the generation

Returns: