diff --git a/Packages/ohif-study-list/client/lib/OHIFStudyMetadataSource.js b/Packages/ohif-study-list/client/lib/OHIFStudyMetadataSource.js index ac780a1c7..6e282c062 100644 --- a/Packages/ohif-study-list/client/lib/OHIFStudyMetadataSource.js +++ b/Packages/ohif-study-list/client/lib/OHIFStudyMetadataSource.js @@ -20,7 +20,7 @@ export class OHIFStudyMetadataSource extends OHIF.viewerbase.StudyMetadataSource /** * Load study info (OHIF.viewer.Studies) and study metadata (OHIF.viewer.StudyMetadataList) for a given study. - * @param {StudySummary|StudyMetadata} Instance of StudySummary or StudyMetadata object + * @param {StudySummary|StudyMetadata} study of StudySummary or StudyMetadata object. */ loadStudy(study) { if (!(study instanceof StudyMetadata) && !(study instanceof StudySummary)) { diff --git a/Packages/ohif-viewerbase/client/lib/classes/StudyMetadataSource.js b/Packages/ohif-viewerbase/client/lib/classes/StudyMetadataSource.js index 286df0e9b..c8a09eec1 100644 --- a/Packages/ohif-viewerbase/client/lib/classes/StudyMetadataSource.js +++ b/Packages/ohif-viewerbase/client/lib/classes/StudyMetadataSource.js @@ -6,19 +6,8 @@ import { OHIFError } from './OHIFError'; export class StudyMetadataSource { /** - * Get study metadata for a given study info - * @param {Object} studyInfo Study info object - */ - getByStudyInfo(studyInfo) { - /** - * Please override this method on a specialized class. - */ - throw new OHIFError('StudyMetadataSource::getByStudyInfo is not overriden. Please, override it in a specialized class. See OHIFStudyMetadataSource for example'); - } - - /** - * Get study metadata for a study with given study InstanceUID - * @param {String} studyInstanceUID Study InstanceUID + * Get study metadata for a study with given study InstanceUID. + * @param {String} studyInstanceUID Study InstanceUID. */ getByInstanceUID(studyInstanceUID) { /** @@ -26,4 +15,16 @@ export class StudyMetadataSource { */ throw new OHIFError('StudyMetadataSource::getByInstanceUID is not overriden. Please, override it in a specialized class. See OHIFStudyMetadataSource for example'); } -} \ No newline at end of file + + /** + * Load study info and study metadata for a given study into the viewer. + * @param {StudySummary|StudyMetadata} study of StudySummary or StudyMetadata object. + */ + loadStudy(study) { + /** + * Please override this method on a specialized class. + */ + throw new OHIFError('StudyMetadataSource::loadStudy is not overriden. Please, override it in a specialized class. See OHIFStudyMetadataSource for example'); + } + +}