cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class InterpretationStateModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.InterpretationStateModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class InterpretationStateModule
extends Module

\* This module defines the Attributes relevant to the state of an interpretation.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
InterpretationStateModule(IDataSet objIDataSet) Instantiates a new interpretation state module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getInterpretationStatusID() Retrieves interpretation Status ID.
java.lang.String	getInterpretationTypeID() Return type of interpretation.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of tags representing the DataElements that belong to this module.
void	setInterpretationStatusID(EnumInterpretationStatusID enumInterpretationStatusID) An Enumerated Value element used to track production status of the interpretation.
void	setInterpretationTypeID(EnumInterpretationTypeID enumInterpretationTypeID) Sets the type of interpretation.
boolean	validateModule() Validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

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

InterpretationStateModule

public InterpretationStateModule(IDataSet objIDataSet)

Instantiates a new interpretation state module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

Validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

Boolean - status indicating success or failure

Throws:

InvalidModuleException - the invalid module exception

setInterpretationTypeID

public void setInterpretationTypeID(EnumInterpretationTypeID enumInterpretationTypeID)

Sets the type of interpretation.

Parameters:

enumInterpretationTypeID - the enum interpretation type id

getInterpretationTypeID

public java.lang.String getInterpretationTypeID()

Return type of interpretation.

Returns:

String - String value of Interpretation Type ID.

setInterpretationStatusID

public void setInterpretationStatusID(EnumInterpretationStatusID enumInterpretationStatusID)

An Enumerated Value element used to track production status of the interpretation. Enumerated Values: CREATED = Interpretation Created,RECORDED = Interpretation captured in a format external to the information system which handles reports,TRANSCRIBED = Interpretation converted into or entered in the internal format of the information system which handles reports, APPROVED = Interpretation Approved

Parameters:

enumInterpretationStatusID - the enum interpretation status id

getInterpretationStatusID

public java.lang.String getInterpretationStatusID()

Retrieves interpretation Status ID.

Returns:

String - String value of Interpretation Status ID.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the collection of tags representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

collection of Tags - returns instance of ISingleCollection containing collection of tags