public interface StudyService
Manage Study
privilege.Modifier and Type | Method and Description |
---|---|
void |
associateDictionaries(String studyId,
List<String> dictionaryIds)
Associates the dictionaries with the study, replacing the current associations.
|
void |
associateExternalDictionaries(String studyId,
Set<String> externalDictionaryIds)
Associates the external dictionaries with the study.
|
void |
associateStandards(String studyId,
Set<String> standardIds)
Associates the standards with the study.
|
void |
disassociateExternalDictionaries(String studyId,
Set<String> externalDictionaryIds)
Disassociates the external dictionaries that are associated with the study.
|
void |
disassociateStandards(String studyId,
Set<String> standardIds)
Disassociates the standards that are associated with the study.
|
String |
exportStudyCodeListsToDataSet(String studyId,
ExportFileCreateInfo info)
Exports to a data set the code lists that are defined with the study.
|
String |
exportStudyDetailsToDataSet(String studyId,
ExportFileCreateInfo info)
Exports the study details to a data set.
|
String |
exportStudyDictionariesToDataSet(String studyId,
ExportFileCreateInfo info)
Exports to a data set the list of dictionaries that are associated with the study.
|
String |
exportStudyExternalDictionariesToDataSet(String studyId,
ExportFileCreateInfo info)
Exports to a data set the list of external dictionaries associated with the study.
|
String |
exportStudyStandardsToDataSet(String studyId,
ExportFileCreateInfo info)
Exports to a data set the list of standards that are associated with the study.
|
Set<String> |
exportStudyTablesToDataSets(String studyId,
String baseStandardName,
String modelId,
BatchFileCreateInfo info)
Exports to data sets the study's table and column metadata for a specified standard and model.
|
String |
exportSupportingDocumentsToDataSet(String studyId,
String baseStandardName,
String modelId,
ExportFileCreateInfo info)
Exports to a data set the study supporting documents for a specified base standard and model.
|
Set<String> |
exportTlfsToDataSets(String studyId,
String baseStandardName,
String modelId,
BatchFileCreateInfo info,
boolean includeAnalysisResultsAndDatasets)
Exports to data sets the study's Tables, Listings, and Figures metadata for a specified standard and model.
|
String |
exportValueLevelMetadataToDataSet(String studyId,
String baseStandardName,
String modelId,
ExportFileCreateInfo info)
Exports to a data set the study's value level metadata for a specified standard and model.
|
String |
exportZeroObservationDataSetsForStudyTables(String studyId,
String baseStandardName,
String modelId,
BatchFileCreateInfo info)
Exports a zero observation data set for every table in a study.
|
List<DictionaryDescriptor> |
getDictionariesAssociatedWithStudy(String studyId)
Gets the dictionaries that are associated with the study.
|
Set<ExternalDictionary> |
getExternalDictionariesAssociatedWithStudy(String studyId)
Gets the external dictionaries that are associated with the study.
|
Set<StandardDescriptor> |
getStandardsAssociatedWithStudy(String studyId)
Gets the standards that are associated with the study.
|
Set<Study> |
getStudiesAssociatedWithDictionary(String dictionaryId)
Gets the studies that are associated with the dictionary.
|
Set<Study> |
getStudiesAssociatedWithExternalDictionary(String externalDictionaryId)
Gets the studies that are associated with the external dictionary.
|
Set<Study> |
getStudiesAssociatedWithStandard(String standardId)
Gets the studies that are associated with the standard.
|
StudyComponentEditableStatus |
getStudyComponentEditableStatus(String studyId,
StudyComponent studyComponent)
Gets the study component editable status, that indicates whether the study component is being edited, by whom,
and when the editing started.
|
StudyUpdateResult |
importStudyCodeLists(String studyId,
StudyComponentImportInfo importInfo,
ExportFileCreateInfo validationInfo)
Updates the study code lists from the import file with options to replace all or add new.
|
void |
importStudyDetails(String studyId,
StudyComponentImportInfo importInfo)
Updates the study details from an import file.
|
StudyUpdateResult |
importStudyFromDefine(String studyId,
String standardId,
String definePath,
String defineVersion,
SourceLocation defineSourceLocation,
UpdateAction codeListUpdateAction,
ExportFileCreateInfo validationInfo)
Imports metadata from a Define-XML file and updates study components based on the contents of the file.
|
StudyUpdateResult |
importStudySupportingDocuments(String studyId,
String baseStandardName,
String modelId,
StudyComponentImportInfo importInfo,
ExportFileCreateInfo validationInfo)
Updates the study supporting documents from the import file with options to replace all or add new.
|
StudyUpdateResult |
importStudyTables(String studyId,
String standardId,
StudyTablesImportInfo importInfo,
ExportFileCreateInfo validationInfo)
Updates the study tables from the import file information with options to replace all or add new.
|
StudyUpdateResult |
importStudyTlfs(String studyId,
String baseStandardName,
String modelId,
TlfImportInfo importInfo,
ExportFileCreateInfo validationInfo)
Updates the study Tables, Listings, and Figures (TLF) from the import files with options to replace all or add
new.
|
StudyUpdateResult |
importStudyValueLevelMetadata(String studyId,
String baseStandardName,
String modelId,
StudyComponentImportInfo importInfo,
ExportFileCreateInfo validationInfo)
Updates the study value level metadata from the import file with options to replace all or add new.
|
StudyComponentEditableStatus |
setStudyComponentAsNotEditable(String studyId,
StudyComponent studyComponent)
Sets the study component as not editable regardless of whether you or someone else has set it for editing.
|
StudyComponentEditableStatus |
setStudyComponentEditableByCurrentUser(String studyId,
StudyComponent studyComponent)
Sets the study component as editable by the current user.
|
Set<Study> getStudiesAssociatedWithStandard(String standardId) throws StandardNotFoundException
standardId
- The identifier of the standard.StandardNotFoundException
- Thrown when the specified standard does not exist.Set<Study> getStudiesAssociatedWithDictionary(String dictionaryId) throws DictionaryNotFoundException
dictionaryId
- The identifier of the dictionary.DictionaryNotFoundException
- Thrown when the specified dictionary does not exist.Set<Study> getStudiesAssociatedWithExternalDictionary(String externalDictionaryId) throws DictionaryNotFoundException
externalDictionaryId
- The identifier of the external dictionary.DictionaryNotFoundException
- Thrown when the specified external dictionary does not exist.void associateStandards(String studyId, Set<String> standardIds) throws StudyNotFoundException, StandardNotFoundException, StandardAssociationExistsException
studyId
- The identifier of the study.standardIds
- The identifiers of the standards.StudyNotFoundException
- Thrown when the specified study does not exist.StandardNotFoundException
- Thrown when one or more of the specified standards do not exist.StandardAssociationExistsException
- Thrown when one or more of the specified standards are currently
associated with the study.void disassociateStandards(String studyId, Set<String> standardIds) throws StudyNotFoundException, StandardAssociationNotFoundException
StudyStandardReferencedException
is thrown.studyId
- The identifier of the study.standardIds
- The identifiers of the standards.StudyNotFoundException
- Thrown when the specified study does not exist.StandardAssociationNotFoundException
- Thrown when one or more of the specified standards are not
associated with the study.void disassociateExternalDictionaries(String studyId, Set<String> externalDictionaryIds) throws StudyNotFoundException, ExternalDictionaryAssociationNotFoundException
studyId
- The identifier of the study.externalDictionaryIds
- The identifiers of the external dictionaries.StudyNotFoundException
- Thrown when the specified study does not exist.ExternalDictionaryAssociationNotFoundException
- Thrown when one or more of the specified external
dictionaries are not associated.void associateExternalDictionaries(String studyId, Set<String> externalDictionaryIds) throws StudyNotFoundException, DictionaryNotFoundException, ExternalDictionaryAssociationExistsException
studyId
- The identifier of the study.externalDictionaryIds
- The identifiers of the external dictionaries to associate.StudyNotFoundException
- Thrown when the specified study does not exist.ExternalDictionaryAssociationExistsException
- Thrown when one or more of the specified external
dictionaries are currently associated.DictionaryNotFoundException
- Thrown when one or more of the specified dictionaries does not exist.void associateDictionaries(String studyId, List<String> dictionaryIds) throws StudyNotFoundException, DictionaryNotFoundException, StudyDictionaryException
setStudyComponentEditableByCurrentUser(String, StudyComponent)
.studyId
- The identifier of the study.dictionaryIds
- The identifiers of the dictionaries.StudyNotFoundException
- Thrown when the specified study does not exist.DictionaryNotFoundException
- Thrown when one or more of the specified dictionaries does not exist.StudyDictionaryException
- Thrown when one or more of the specified dictionaries cannot be associated.Set<StandardDescriptor> getStandardsAssociatedWithStudy(String studyId) throws StudyNotFoundException
studyId
- The identifier of the study.StudyNotFoundException
- Thrown when the specified study does not exist.List<DictionaryDescriptor> getDictionariesAssociatedWithStudy(String studyId) throws StudyNotFoundException
studyId
- The identifier of the study.StudyNotFoundException
- Thrown when the specified study does not exist.Set<ExternalDictionary> getExternalDictionariesAssociatedWithStudy(String studyId) throws StudyNotFoundException
studyId
- The identifier of the study.StudyNotFoundException
- Thrown when the specified study does not exist.StudyComponentEditableStatus getStudyComponentEditableStatus(String studyId, StudyComponent studyComponent) throws StudyNotFoundException
studyId
- The identifier of the study.studyComponent
- The StudyComponent
object.StudyNotFoundException
- Thrown when the specified study does not exist.StudyComponentEditableStatus setStudyComponentEditableByCurrentUser(String studyId, StudyComponent studyComponent) throws StudyNotFoundException, StudyComponentEditException
studyId
- The identifier of the study.studyComponent
- The StudyComponent
object.StudyNotFoundException
- Thrown when the specified study does not exist.StudyComponentEditException
- Thrown when the study component cannot be set as editable by the current
user.StudyComponentEditableStatus setStudyComponentAsNotEditable(String studyId, StudyComponent studyComponent) throws StudyNotFoundException, StudyComponentEditException
studyId
- The identifier of the study.studyComponent
- The StudyComponent
.StudyNotFoundException
- Thrown when the specified study does not exist.StudyComponentEditException
- Thrown when the study component cannot be set as not editable.String exportStudyDetailsToDataSet(String studyId, ExportFileCreateInfo info) throws StudyNotFoundException, ExportException
studyId
- The identifier of the study.info
- The method to add the exported data set.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.String exportStudyStandardsToDataSet(String studyId, ExportFileCreateInfo info) throws StudyNotFoundException, ExportException
studyId
- The identifier of the study.info
- The method to add the exported data set.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.void importStudyDetails(String studyId, StudyComponentImportInfo importInfo) throws StudyNotFoundException, StudyUpdateException, ImportException
studyId
- The identifier of the study.importInfo
- The import information.StudyNotFoundException
- Thrown when the specified study does not exist.StudyUpdateException
- Thrown when the study metadata cannot be updated.ImportException
- Thrown when there is an issue processing the import file.String exportStudyExternalDictionariesToDataSet(String studyId, ExportFileCreateInfo info) throws StudyNotFoundException, ExportException
studyId
- The identifier of the study.info
- The method to add the exported data set.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.String exportStudyDictionariesToDataSet(String studyId, ExportFileCreateInfo info) throws StudyNotFoundException, ExportException
studyId
- The identifier of the study.info
- The method to add the exported data set.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.String exportStudyCodeListsToDataSet(String studyId, ExportFileCreateInfo info) throws StudyNotFoundException, ExportException
studyId
- The identifier of the study.info
- The method to add the exported data set.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.StudyUpdateResult importStudyCodeLists(String studyId, StudyComponentImportInfo importInfo, ExportFileCreateInfo validationInfo) throws StudyNotFoundException, StudyCodeListUpdateException, ImportException, ValidationReportException
studyId
- The identifier of the study.importInfo
- The import information.validationInfo
- The method to create a validation report, which contains the errors, warnings, and notes
about the import file. Specifying null indicates that no report is be saved.StudyNotFoundException
- Thrown when the specified study does not exist.StudyCodeListUpdateException
- Thrown when the study code lists cannot be updated.ImportException
- Thrown when there is an issue importing the file.ValidationReportException
- Thrown when the validation report cannot be created.StudyUpdateResult importStudyTables(String studyId, String standardId, StudyTablesImportInfo importInfo, ExportFileCreateInfo validationInfo) throws StudyNotFoundException, StandardNotFoundException, StudyTableUpdateException, ImportException, ValidationReportException
studyId
- The identifier of the study.standardId
- The identifier of the standard.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.StudyNotFoundException
- Thrown when the specified study does not exist.StandardNotFoundException
- Thrown when the specified standard does not exist.StudyTableUpdateException
- Thrown when the study tables cannot be updated.ImportException
- Thrown when there is an issue importing the files.ValidationReportException
- Thrown when the validation report cannot be created.String exportSupportingDocumentsToDataSet(String studyId, String baseStandardName, String modelId, ExportFileCreateInfo info) throws StudyNotFoundException, ExportException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.info
- The method to add the exported data set.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.StudyUpdateResult importStudySupportingDocuments(String studyId, String baseStandardName, String modelId, StudyComponentImportInfo importInfo, ExportFileCreateInfo validationInfo) throws StudyNotFoundException, StudySupportingDocumentUpdateException, ImportException, ValidationReportException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.importInfo
- The import information to update the study metadata.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.StudyNotFoundException
- Thrown when the specified study does not exist.StudySupportingDocumentUpdateException
- Thrown when the study supporting documents cannot be updated.ImportException
- Thrown when there is an issue importing the file.ValidationReportException
- Thrown when the validation report cannot be created.String exportValueLevelMetadataToDataSet(String studyId, String baseStandardName, String modelId, ExportFileCreateInfo info) throws StudyNotFoundException, ExportException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.info
- The method to add the exported data set.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.StudyUpdateResult importStudyValueLevelMetadata(String studyId, String baseStandardName, String modelId, StudyComponentImportInfo importInfo, ExportFileCreateInfo validationInfo) throws StudyNotFoundException, StudyValueLevelMetadataUpdateException, ImportException, ValidationReportException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.importInfo
- The import information to update the study metadata.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.StudyNotFoundException
- Thrown when the specified study does not exist.StudyValueLevelMetadataUpdateException
- Thrown when the study value level metadata cannot be updated.ImportException
- Thrown when there is an issue importing the file.ValidationReportException
- Thrown when the validation report cannot be created.Set<String> exportStudyTablesToDataSets(String studyId, String baseStandardName, String modelId, BatchFileCreateInfo info) throws StudyNotFoundException, ExportException
path
variable
in BatchFileCreateInfo
and these suffixes:
For example, if the path
is /YOURORG/Files/st, st is used as a prefix, and the tables data set is
created with name st_tables.sas7bdat.
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.info
- The method to add the exported data set.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.Set<String> exportTlfsToDataSets(String studyId, String baseStandardName, String modelId, BatchFileCreateInfo info, boolean includeAnalysisResultsAndDatasets) throws StudyNotFoundException, ExportException
path
variable in BatchFileCreateInfo
and these suffixes, which represent sections and TLFs:
For analysis standards, the same two data sets are created above. If you specify true to include analysis results and data sets, two additional data sets are created (four total):
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.info
- The method to add the exported data set.includeAnalysisResultsAndDatasets
- Indicates whether to include analysis results and data sets. This
parameter applies only when the standard model is analysis.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.StudyUpdateResult importStudyTlfs(String studyId, String baseStandardName, String modelId, TlfImportInfo importInfo, ExportFileCreateInfo validationInfo) throws StudyNotFoundException, TlfUpdateException, ImportException, ValidationReportException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.importInfo
- The import information to update the study metadata.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.StudyNotFoundException
- Thrown when the specified study does not exist.TlfUpdateException
- Thrown when the study TLFs cannot be updated.ImportException
- Thrown when there is an issue importing the file.ValidationReportException
- Thrown when the validation report cannot be created.String exportZeroObservationDataSetsForStudyTables(String studyId, String baseStandardName, String modelId, BatchFileCreateInfo info) throws StudyNotFoundException, ExportException
BatchFileCreateInfo
.studyId
- The identifier of the study.baseStandardName
- The name of the base standard such, as SDTM and ADaM.modelId
- The identifier of the model.info
- The method to add the exported data sets.StudyNotFoundException
- Thrown when the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.StudyUpdateResult importStudyFromDefine(String studyId, String standardId, String definePath, String defineVersion, SourceLocation defineSourceLocation, UpdateAction codeListUpdateAction, ExportFileCreateInfo validationInfo) throws StudyNotFoundException, StandardNotFoundException, StudyUpdateException, ImportException, ValidationReportException
studyId
- The identifier of the study.standardId
- The identifier of the standard.definePath
- The path of the Define-XML file.defineVersion
- The version of the Define-XML file. Specifying null
gets the latest version of
the file.defineSourceLocation
- The source location of the Define-XML file.codeListUpdateAction
- The method to the codelists.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.StudyNotFoundException
- Thrown when the specified study does not exist.StandardNotFoundException
- Thrown when the specified standard does not exist.StudyUpdateException
- Thrown when the study 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) 2020, SAS Institute Inc., Cary, NC, USA</i>