Package nis.svc.mdl.api
Interface ModelService
-
public interface ModelService
The Model Service enables user programs to source and blend Northfield risk model data. This data can be used in the optimiser or in risk reporting and performance tools.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
close()
Close the service.ModelProject
create(java.lang.String code, java.lang.String date)
Create an empty model project with the provided code and date.ModelProject
load(ModelProject project)
Load a project based on the setting information in the provided project.ModelReport
test(ModelProject project)
Test a project based on the setting information in the provided project.
-
-
-
Method Detail
-
create
ModelProject create(java.lang.String code, java.lang.String date)
Create an empty model project with the provided code and date.- Parameters:
code
- A supported model code.date
- A valid date for the model code.- Returns:
- The project.
-
load
ModelProject load(ModelProject project)
Load a project based on the setting information in the provided project.- Parameters:
project
- A properly configured settings object.- Returns:
- The loaded project with the Model data filled. If the project fails, then the report will have a fail message that contains the exception information.
-
test
ModelReport test(ModelProject project)
Test a project based on the setting information in the provided project. This will run the query as per the "load" process, however it will not return any data other than the logs.- Parameters:
project
- A properly configured settings object.- Returns:
- A project with only the logs in the results.
-
close
void close() throws ModelException
Close the service. Provided for the container to call and note called by user programs.- Throws:
ModelException
- Call failed.
-
-