public interface TlfTemplateService
Modifier and Type | Method and Description |
---|---|
TlfTemplate |
createTlfTemplate(String name,
String description)
Creates a TLF template.
|
Set<String> |
exportTlfsToDataSets(String tlfTemplateId,
BatchFileCreateInfo fileCreateInfo,
boolean includeAnalysisResults)
Exports to data sets the global Tables, Listings, and Figures (TLF) metadata for a specified TLF template.
|
Set<TlfTemplate> |
getTlfTemplates()
Gets the TLF templates.
|
TlfUpdateResult |
importTlfsToTlfTemplate(TlfTemplateImportInfo importInfo,
ExportFileCreateInfo validationInfo)
Updates the Tables, Listings, and Figures (TLF) from the import files to the TLF template specified.
|
TlfTemplate createTlfTemplate(String name, String description) throws TlfTemplateExistsException
name
- The name of the TLF template.description
- The description of the TLF template.TlfTemplateExistsException
- Thrown when a TLF template by the name exists.Set<TlfTemplate> getTlfTemplates()
Set<String> exportTlfsToDataSets(String tlfTemplateId, BatchFileCreateInfo fileCreateInfo, boolean includeAnalysisResults) throws TlfTemplateNotFoundException, ExportException
path
variable in BatchFileCreateInfo
and these suffixes,
which represent sections and TLFs:
If you specify true to include analysis results and data sets, two additional data sets are created (four total):
tlfTemplateId
- The unique identifier of the TLF template.fileCreateInfo
- The method to add the exported data set.includeAnalysisResults
- Indicates whether to include analysis results and data sets.TlfTemplateNotFoundException
- Thrown when the specified TLF template does not exist.ExportException
- Thrown when there is an issue exporting the metadata.TlfUpdateResult importTlfsToTlfTemplate(TlfTemplateImportInfo importInfo, ExportFileCreateInfo validationInfo) throws TlfTemplateNotFoundException, TlfUpdateException, ImportException, ValidationReportException
importInfo
- The import information.validationInfo
- The method to create a validation report, which contains errors, warnings, and notes about
the import file. Specifying null indicates that no report is saved.TlfTemplateNotFoundException
- Thrown when the specified TLF template does not exist.TlfUpdateException
- Thrown when the TLFs cannot be updated.ImportException
- Thrown when there is an issue importing the file.ValidationReportException
- Thrown when the validation report cannot be created.<i>Copyright (c) 2021, SAS Institute Inc., Cary, NC, USA</i>