cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class StudyClassificationModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudyClassificationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class StudyClassificationModule
extends Module

\* This module defines the Attributes relevant to classifying a study.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
StudyClassificationModule(IDataSet objIDataSet) Instantiates a new study classification module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getStudyComments() Retrieves User-defined comments about the study.
java.lang.String	getStudyPriorityID() Retrieves the priority of the study.
java.lang.String	getStudyStatusID() Retrieves the state of the study.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setStudyComments(java.lang.String strStudyComments) User-defined comments about the study.
void	setStudyPriorityID(EnumStudyPriorityID enumStudyPriorityID) Identifies the priority of the study.
void	setStudyStatusID(EnumStudyStatusID enumStudyStatusID) Identifies the state of the study.
boolean	validateModule() Validates the Module's DataElement according to Dicom Standard.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

StudyClassificationModule

public StudyClassificationModule(IDataSet objIDataSet)

Instantiates a new study classification module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()

Description copied from interface: IModule

Validates the Module's DataElement according to Dicom Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - shows status as success or failure.

setStudyStatusID

public void setStudyStatusID(EnumStudyStatusID enumStudyStatusID)

Identifies the state of the study. Enumerated Values:CREATED = Created but not yet scheduled, SCHEDULED = Scheduled but not yet started, ARRIVED = Patient Arrived but study not started, STARTED = Started but not yet finished, COMPLETED = Complete but image quality not verified, VERIFIED = Complete and image quality verified, READ = Read by the Physicians

Parameters:

enumStudyStatusID - Enum value of Study Status ID.

setStudyPriorityID

public void setStudyPriorityID(EnumStudyPriorityID enumStudyPriorityID)

Identifies the priority of the study. Enumerated values: LOW, MED, HIGH.

Parameters:

enumStudyPriorityID - Enum value of Study Priority ID.

setStudyComments

public void setStudyComments(java.lang.String strStudyComments)

User-defined comments about the study.

Parameters:

strStudyComments - String value of Study Comments.

getStudyStatusID

public java.lang.String getStudyStatusID()

Retrieves the state of the study.

Returns:

String - String value of state of the study.

getStudyPriorityID

public java.lang.String getStudyPriorityID()

Retrieves the priority of the study.

Returns:

String - String value of Study Priority ID.

getStudyComments

public java.lang.String getStudyComments()

Retrieves User-defined comments about the study.

Returns:

String - String value of Study Comments.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags