public interface StudyTlfService
Modifier and Type | Method and Description |
---|---|
List<AnalysisDataset> |
getAnalysisDatasetsByResultId(String studyId,
String baseStandardName,
String modelId,
String resultId)
Gets the analysis data sets by the analysis results id.
|
List<AnalysisDataset> |
getAnalysisDatasetsByResultIdentifier(String studyId,
String baseStandardName,
String modelId,
String resultIdentifier)
Gets the analysis data sets by the analysis results identifier.
|
List<AnalysisResult> |
getAnalysisResultsByStudyTlfId(String studyId,
String baseStandardName,
String modelId,
String tlfId)
Gets the analysis results for the TLF id.
|
List<AnalysisResult> |
getAnalysisResultsByStudyTlfIdentifier(String studyId,
String baseStandardName,
String modelId,
String tlfIdentifier)
Gets the analysis results for the TLF identifier.
|
SectionDescriptor |
getStudySectionDescriptorById(String studyId,
String id)
Gets the study section descriptor by the specified id.
|
List<SectionDescriptor> |
getStudySections(String studyId,
String baseStandardName,
String modelId)
Gets the study sections.
|
Tlf |
getStudyTlfByTlfIdentifier(String studyId,
String baseStandardName,
String modelId,
String tlfIdentifier)
Gets the study TLF with the specified TLF identifier.
|
List<Tlf> |
getStudyTlfsBySectionId(String studyId,
String baseStandardName,
String modelId,
String sectionId,
boolean recurse)
Gets the study TLFs within the specified section.
|
List<Tlf> |
getStudyTlfsBySectionNameAndIdentifier(String studyId,
String baseStandardName,
String modelId,
String sectionName,
String sectionIdentifier,
boolean recurse)
Gets the study TLFs within the specified section.
|
List<AttributeMetadata> |
getTlfAttributeMetadata()
Gets the TLF attribute metadata.
|
StudyTlfInfo |
getTlfs(String studyId,
String baseStandardName,
String modelId)
Gets the Tables, Listings and Figures for the specified study.
|
StudyTlfInfo |
setTlfs(StudyTlfInfo studyTlfInfo)
Sets the Tables, Listings and Figures for the study.
|
StudyTlfInfo getTlfs(String studyId, String baseStandardName, String modelId) throws StudyNotFoundException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.StudyNotFoundException
- Thrown when the specified study does not exist.StudyTlfInfo setTlfs(StudyTlfInfo studyTlfInfo) throws StudyNotFoundException, TlfUpdateException
studyTlfInfo
- The study and TLF information to update the study TLFs.StudyNotFoundException
- Thrown when the specified study does not exist.TlfUpdateException
- Thrown when there was an issue when updating the study TLFs.SectionDescriptor getStudySectionDescriptorById(String studyId, String id) throws StudyNotFoundException, SectionNotFoundException
studyId
- The id of the study.id
- The id of the section.StudyNotFoundException
- Thrown when the specified study does not exist.SectionNotFoundException
- Thrown when the specified section does not exist.List<AttributeMetadata> getTlfAttributeMetadata() throws ModelNotFoundException
ModelNotFoundException
- Thrown when the TLF model does not exist.List<SectionDescriptor> getStudySections(String studyId, String baseStandardName, String modelId) throws StudyNotFoundException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.StudyNotFoundException
- Thrown when the specified study does not exist.List<Tlf> getStudyTlfsBySectionId(String studyId, String baseStandardName, String modelId, String sectionId, boolean recurse) throws StudyNotFoundException, SectionNotFoundException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.sectionId
- The identifier of the section. See AbstractIdentifiable.getId()
.recurse
- Indicates whether to retrieve TLFs from subsections.StudyNotFoundException
- Thrown when the specified study does not exist.SectionNotFoundException
- Thrown when the specified section does not exist.List<Tlf> getStudyTlfsBySectionNameAndIdentifier(String studyId, String baseStandardName, String modelId, String sectionName, String sectionIdentifier, boolean recurse) throws StudyNotFoundException, SectionNotFoundException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.sectionName
- The name of the section.sectionIdentifier
- The section identifier of the section. See
SectionDescriptor.getSectionIdentifier()
.recurse
- Indicates whether to retrieve TLFs from subsections.StudyNotFoundException
- Thrown when the specified study does not exist.SectionNotFoundException
- Thrown when the specified section does not exist.List<AnalysisResult> getAnalysisResultsByStudyTlfId(String studyId, String baseStandardName, String modelId, String tlfId) throws StudyNotFoundException, TlfNotFoundException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.tlfId
- The TLF id.StudyNotFoundException
- Thrown when the specified study does not exist.TlfNotFoundException
- Thrown when the specified TLF does not exist.List<AnalysisResult> getAnalysisResultsByStudyTlfIdentifier(String studyId, String baseStandardName, String modelId, String tlfIdentifier) throws StudyNotFoundException, TlfNotFoundException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.tlfIdentifier
- The TLF identifier.StudyNotFoundException
- Thrown when the specified study does not exist.TlfNotFoundException
- Thrown when the specified TLF does not exist.List<AnalysisDataset> getAnalysisDatasetsByResultId(String studyId, String baseStandardName, String modelId, String resultId) throws StudyNotFoundException, AnalysisResultNotFoundException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.resultId
- The analysis result id.StudyNotFoundException
- Thrown when the specified study does not exist.AnalysisResultNotFoundException
- Thrown when the specified analysis result does not exist.List<AnalysisDataset> getAnalysisDatasetsByResultIdentifier(String studyId, String baseStandardName, String modelId, String resultIdentifier) throws StudyNotFoundException, AnalysisResultNotFoundException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.resultIdentifier
- The analysis result identifier.StudyNotFoundException
- Thrown when the specified study does not exist.AnalysisResultNotFoundException
- Thrown when the specified analysis result does not exist.Tlf getStudyTlfByTlfIdentifier(String studyId, String baseStandardName, String modelId, String tlfIdentifier) throws StudyNotFoundException, TlfNotFoundException
studyId
- The identifier of the study.baseStandardName
- The name of the base standard, such as SDTM and ADaM.modelId
- The identifier of the model.tlfIdentifier
- The TLF identifier.StudyNotFoundException
- Thrown when the specified TLF does not exist.TlfNotFoundException
- Thrown when the specified TLF does not exist.<i>Copyright (c) 2021, SAS Institute Inc., Cary, NC, USA</i>