cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class UnifiedProcedureStepProgressInformationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.UnifiedProcedureStepProgressInformationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class UnifiedProcedureStepProgressInformationModule
extends Module

\* This module specifies the Attributes that describe Unified Procedure Step Progress Information Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
UnifiedProcedureStepProgressInformationModule(IDataSet objIDataSet) Instantiates a UnifiedProcedureStepProgressInformationModule.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getInputReadinessState() Return ProcedureStepState
ProcedureStepProgressInformationSequence	getQAResultsSequence() Retrieves pre-initialized object of Procedure Step ProgressInformation Sequence.
ISingleCollection<ITag>	getVectorOfKeys() Gets the vector of keys.
void	setProcedureStepState(EnumProcedureStepState enumInputReadinessState) Sets State of the Procedure Step.
boolean	validateModule() This method 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

UnifiedProcedureStepProgressInformationModule

public UnifiedProcedureStepProgressInformationModule(IDataSet objIDataSet)

Instantiates a UnifiedProcedureStepProgressInformationModule.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method 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 - - If validation of Module fails

setProcedureStepState

public void setProcedureStepState(EnumProcedureStepState enumInputReadinessState)

Sets State of the Procedure Step. Enumerated Values: SCHEDULED INPROGRESS CANCELED COMPLETED

Parameters:

enumProcedureStepState - enum value of Input Readiness State.

getInputReadinessState

public java.lang.String getInputReadinessState()

Return ProcedureStepState

Returns:

String - value of ProcedureStepState

getQAResultsSequence

public ProcedureStepProgressInformationSequence getQAResultsSequence()

Retrieves pre-initialized object of Procedure Step ProgressInformation Sequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ProcedureStepProgressInformationSequence - instance of Procedure Step ProgressInformation Sequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

Description copied from class: Module

Gets the vector of keys.

Overrides:

getVectorOfKeys in class Module

Returns:

the vector of keys