|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDocumentGenerator
DocumentGenerator API
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 for receiving important progress messages from the document generation |
void |
unregisterListener(RPEListener listener)
Unregisters the listener from the engine |
Methods inherited from interface com.ibm.rational.rpe.engine.IControl |
---|
pause, resume, stop |
Method Detail |
---|
void registerListener(RPEListener listener)
listener
- void unregisterListener(RPEListener listener)
listener
- void enableDebug(boolean debug)
debug
- java.lang.Thread publish(RPEDocumentSpecification docSpec, int previewQueryLimit) throws RPEException
docSpec
- previewQueryLimit
-
RPEException
com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus publishSync(RPEDocumentSpecification docspec, int previewQueryLimit) throws RPEException
docspec
- previewQueryLimit
-
RPEException
java.util.List<RPEResult> getResults()
com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus getStatus()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |