public interface StudyService
Manage Study
privilege.Modifier and Type | Method and Description |
---|---|
void |
associateDictionaries(String studyId,
List<String> dictionaryIds)
Associates the dictionaries to the study replacing any associations that already exist.
|
void |
associateExternalDictionaries(String studyId,
Set<String> externalDictionaryIds)
Associates the external dictionaries to the study.
|
void |
associateStandards(String studyId,
Set<String> standardIds)
Associates the standards to the study.
|
void |
disassociateExternalDictionaries(String studyId,
Set<String> externalDictionaryIds)
Disassociates the external dictionaries that are associated to the study.
|
void |
disassociateStandards(String studyId,
Set<String> standardIds)
Disassociates the standards that are associated to the study.
|
String |
exportStudyAnalysisResultsMetadataToDataSet(String studyId,
String baseStandardName,
String modelId,
ExportFileCreateInfo info)
Deprecated.
As of Java API 2.2. Will be replaced in a subsequent release with a new method.
|
String |
exportStudyCodeListsToDataSet(String studyId,
ExportFileCreateInfo info)
Exports the code lists defined at the study to a data set.
|
String |
exportStudyDetailsToDataSet(String studyId,
ExportFileCreateInfo info)
Exports the study details including study name, study description, protocol, study identifier, and file
identifier to a data set.
|
String |
exportStudyDictionariesToDataSet(String studyId,
ExportFileCreateInfo info)
Exports the list of dictionaries associated with the study to a data set.
|
String |
exportStudyExternalDictionariesToDataSet(String studyId,
ExportFileCreateInfo info)
Exports the list of external dictionaries associated with the study to a data set.
|
String |
exportStudyStandardsToDataSet(String studyId,
ExportFileCreateInfo info)
Exports the list of standards associated with the study to a data set.
|
Set<String> |
exportStudyTablesToDataSets(String studyId,
String baseStandardName,
String modelId,
BatchFileCreateInfo info)
Exports the study's table and column metadata for a specified standard and model to data sets.
|
String |
exportSupportingDocumentsToDataSet(String studyId,
String baseStandardName,
String modelId,
ExportFileCreateInfo info)
Exports the study's supporting documents for a specified standard and model to a data set.
|
String |
exportValueLevelMetadataToDataSet(String studyId,
String baseStandardName,
String modelId,
ExportFileCreateInfo info)
Exports the study's value level metadata for a specified standard and model to a data set.
|
String |
exportZeroObservationDataSetsForStudyTables(String studyId,
String baseStandardName,
String modelId,
BatchFileCreateInfo info)
Exports a zero observation data set for every table in the study.
|
List<DictionaryDescriptor> |
getDictionariesAssociatedWithStudy(String studyId)
Gets dictionaries associated with the study.
|
Set<ExternalDictionary> |
getExternalDictionariesAssociatedWithStudy(String studyId)
Gets external dictionaries associated with the study.
|
Set<StandardDescriptor> |
getStandardsAssociatedWithStudy(String studyId)
Gets standards 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 which indicates if it is being edited, by whom and when the edit
started.
|
StudyComponentEditableStatus |
setStudyComponentAsNotEditable(String studyId,
StudyComponent studyComponent)
Sets the study component as not editable whether you or someone else has set it for edit.
|
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 if the specified standard does not exist.Set<Study> getStudiesAssociatedWithDictionary(String dictionaryId) throws DictionaryNotFoundException
dictionaryId
- The identifier of the dictionary.DictionaryNotFoundException
- Thrown if the specified dictionary does not exist.Set<Study> getStudiesAssociatedWithExternalDictionary(String externalDictionaryId) throws DictionaryNotFoundException
externalDictionaryId
- The identifier of the external dictionary.DictionaryNotFoundException
- Thrown if 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 to associate to the study.StudyNotFoundException
- Thrown if the specified study does not exist.StandardNotFoundException
- Thrown if one or more of the specified standards do not exist.StandardAssociationExistsException
- Thrown if one or more of the specified standards are already
associated to the study.void disassociateStandards(String studyId, Set<String> standardIds) throws StudyNotFoundException, StandardAssociationNotFoundException
StudyStandardReferencedException
will be thrown.studyId
- The identifier of the study.standardIds
- The identifiers of the standards to remove from the study.StudyNotFoundException
- Thrown if the specified study does not exist.StandardAssociationNotFoundException
- Thrown if one or more of the specified standards are not associated
to 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 to remove from the study.StudyNotFoundException
- Thrown if the specified study does not exist.ExternalDictionaryAssociationNotFoundException
- Thrown if one or more of the specified external
dictionaries are not associated to the study.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 to the study.StudyNotFoundException
- Thrown if the specified study does not exist.ExternalDictionaryAssociationExistsException
- Thrown if one or more of the specified external dictionaries
are already associated to the study.DictionaryNotFoundException
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 to associate to the study.StudyNotFoundException
- Thrown if the specified study does not exist.DictionaryNotFoundException
- Thrown if one or more of the specified dictionaries do not exist.StudyDictionaryException
- Thrown if one or more of the specified dictionaries could not be associated to
the study.Set<StandardDescriptor> getStandardsAssociatedWithStudy(String studyId) throws StudyNotFoundException
studyId
- The identifier of the study.StudyNotFoundException
- Thrown if the specified study does not exist.List<DictionaryDescriptor> getDictionariesAssociatedWithStudy(String studyId) throws StudyNotFoundException
studyId
- The identifier of the study.StudyNotFoundException
- Thrown if the specified study does not exist.Set<ExternalDictionary> getExternalDictionariesAssociatedWithStudy(String studyId) throws StudyNotFoundException
studyId
- The identifier of the study.StudyNotFoundException
- Thrown if the specified study does not exist.StudyComponentEditableStatus getStudyComponentEditableStatus(String studyId, StudyComponent studyComponent) throws StudyNotFoundException
studyId
- The identifier of the study.studyComponent
- The StudyComponent
in which to get the editable status.StudyNotFoundException
- Thrown if the specified study does not exist.StudyComponentEditableStatus setStudyComponentEditableByCurrentUser(String studyId, StudyComponent studyComponent) throws StudyNotFoundException, StudyComponentEditException
studyId
- The identifier of the study.studyComponent
- The StudyComponent
to set as editable.StudyNotFoundException
- Thrown if the specified study does not exist.StudyComponentEditException
- Thrown if the study component could not 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
to set as not editable.StudyNotFoundException
- Thrown if the specified study does not exist.StudyComponentEditException
- Thrown if the study component could not 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 if 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 if the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.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 if 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 if 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 if the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.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 if the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.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 if the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.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 if the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.@Deprecated String exportStudyAnalysisResultsMetadataToDataSet(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 if the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.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 if the specified study does not exist.ExportException
- Thrown when there is an issue exporting the metadata.Copyright (c) 2019, SAS Institute Inc., Cary, NC, USA