|
Traceability | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IEngine
The Factory interface. provides some methods to interact with the TopCased Traceability Tool model
org.topcased.traceability| Method Summary | |
|---|---|
java.lang.String |
getProjectFilename()
|
void |
newProject(java.lang.String filename)
Creates a new project in the filename passed in parameter. |
void |
newProjectWithOverwrite(java.lang.String filename)
|
void |
printReport(Project aProject,
java.lang.String outputStr)
|
void |
printRulesReport(Project aProject,
java.lang.String outputStr)
|
void |
reloadProject(Project aProject)
|
void |
reloadProjectForcing(Project aProject,
java.lang.Boolean update)
|
| Method Detail |
|---|
void newProject(java.lang.String filename)
throws ProjectFileAlreadyDefinedException,
CannotCreateProjectFileException
filename - that will contain the traceability project structure
ProjectFileAlreadyDefinedException - indicates the project that
the user want to create already exists
CannotCreateProjectFileException - indicates that an exception
occured during the project creation
void newProjectWithOverwrite(java.lang.String filename)
throws ProjectFileAlreadyDefinedException,
CannotCreateProjectFileException
filename - that will contain the traceability project structure
ProjectFileAlreadyDefinedException - indicates the project that
the user want to create already exists
CannotCreateProjectFileException - indicates that an exception
occured during the project creationjava.lang.String getProjectFilename()
void reloadProject(Project aProject)
throws FilesNeedToBeReloadException,
ResourceLoadingException,
MustBeTTMKindFileException,
AnalysisException
the - project the user want to reload
FilesNeedToBeReloadException - indicates that some files in project
have changed since the last reloading action
ResourceLoadingException - indicates the loading
of resource failed
AnalysisException - indicates that exceptions occured
during project analysis
MustBeTTMKindFileException - indicates that the extension of
filename in parameter is wrong
void reloadProjectForcing(Project aProject,
java.lang.Boolean update)
throws ResourceLoadingException,
MustBeTTMKindFileException,
AnalysisException
the - project the user want to reloadupdate - boolean indicates if the user want to update modified file
during reloading action
ResourceLoadingException - indicates the loading
of resource failed
AnalysisException - indicates that exceptions occured
during project analysis
MustBeTTMKindFileException - indicates that the extension of
filename in parameter is wrong
void printReport(Project aProject,
java.lang.String outputStr)
throws ReportGenerationException,
MustBeTTMKindFileException
the - project which report the user want to produce
MustBeTTMKindFileException - indicates that the extension of
filename in parameter is wrong
ReportGenerationException - indicates that some exception occured
during report generation
void printRulesReport(Project aProject,
java.lang.String outputStr)
throws ReportGenerationException,
MustBeTTMKindFileException
the - project which report the user want to produce
MustBeTTMKindFileException - indicates that the extension of
filename in parameter is wrong
ReportGenerationException - indicates that some exception occured
during report generation
|
Traceability | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.