cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class UnifiedProcedureStepScheduledProcedureInformationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.UnifiedProcedureStepScheduledProcedureInformationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class UnifiedProcedureStepScheduledProcedureInformationModule
extends Module

\* This module describes attributes related to Unified Procedure Step Scheduled Procedure 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
UnifiedProcedureStepScheduledProcedureInformationModule(IDataSet objIDataSet) Instantiates a UnifiedProcedureStepScheduledProcedureInformationModule.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCommentsOnTheScheduledProcedureStep() Retrieves Comments on the ScheduledProcedure Step
java.lang.String	getExpectedCompletionDateTime() Retrieves Scheduled Procedure Step StartDateTime
InputInformationSequence	getInputInformationSequence() Retrieves pre-initialized object of Input Information Sequence.
java.lang.String	getInputReadinessState() Return InputReadinessState
java.lang.String	getProcedureStepLabel() Return Procedure Step Label
ScheduledHumanPerformersSequence	getScheduledHumanPerformersSequence() Retrieves pre-initialized object of Scheduled Human PerformersSequence.
java.lang.String	getScheduledProcedureStepModificationDateTime() Retrieves Scheduled Procedure StepModification Date and Time
java.lang.String	getScheduledProcedureStepPriority() Return ScheduledProcedureStepPriority
java.lang.String	getScheduledProcedureStepStartDateTime() Retrieves Scheduled Procedure Step StartDateTime
ScheduledProcessingParametersSequence	getScheduledProcessingParametersSequence() Retrieves pre-initialized object of Scheduled Processing ParametersSequence.
ScheduledStationClassCodeSequence	getScheduledStationClassCodeSequence() Retrieves pre-initialized object of Scheduled Station Class Code Sequence.
ScheduledStationGeographicLocationCodeSequence	getScheduledStationGeographicLocationCodeSequence() Retrieves pre-initialized object of Scheduled Station Geographic Location Code Sequence.
ScheduledStationNameCodeSequence	getScheduledStationNameCodeSequence() Retrieves pre-initialized object of Scheduled Station Name CodeSequence.
ScheduledWorkitemCodeSequence	getScheduledWorkitemCodeSequence() Retrieves pre-initialized object ofScheduled Workitem CodeSequence.
java.lang.String	getStudyInstanceUID() Retrieves Study Instance UID
ISingleCollection<ITag>	getVectorOfKeys() Gets the vector of keys.
java.lang.String	getWorklistLabel() Return Worklist Label
void	setCommentsOnTheScheduledProcedureStep(java.lang.String strCommentsOnTheScheduledProcedureStep) Sets Comments on the ScheduledProcedure Step
void	setExpectedCompletionDateTime(java.lang.String strExpectedCompletionDateTime) Sets Expected Completion DateTime
void	setInputReadinessState(EnumInputReadinessState enumInputReadinessState) Sets readiness state of the Input Information Sequence (0040,4021) and the referenced instances.
void	setProcedureStepLabel(java.lang.String strProcedureStepLabel) Sets Procedure Step Label
void	setScheduledProcedureStepModificationDateTime(java.lang.String strScheduledProcedureStepModificationDateTime) Sets Scheduled Procedure StepModification Date and Time
void	setScheduledProcedureStepPriority(EnumScheduledProcedureStepPriority enumScheduledProcedureStepPriority) Sets priority of the scheduled Procedure Step Enumerated Values: HIGH:used to indicate an urgent or emergent work item, equivalent to a STAT request.
void	setScheduledProcedureStepStartDateTime(java.lang.String strScheduledProcedureStepStartDateTime) Sets Scheduled Procedure Step StartDateTime
void	setStudyInstanceUID(java.lang.String strStudyInstanceUID) Sets a Study Instance UID
void	setWorklistLabel(java.lang.String strWorklistLabel) Sets Worklist Label
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

UnifiedProcedureStepScheduledProcedureInformationModule

public UnifiedProcedureStepScheduledProcedureInformationModule(IDataSet objIDataSet)

Instantiates a UnifiedProcedureStepScheduledProcedureInformationModule.

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

setScheduledProcedureStepPriority

public void setScheduledProcedureStepPriority(EnumScheduledProcedureStepPriority enumScheduledProcedureStepPriority)

Sets priority of the scheduled Procedure Step Enumerated Values: HIGH:used to indicate an urgent or emergent work item, equivalent to a STAT request. MEDIUM:used to indicate a work item that has a priority less than HIGHand higher than LOW. It can be used to further stratify workitems. LOW:used to indicate a routine or non-urgent work item.

Parameters:

enumScheduledProcedureStepPriority - enum value of Setup Device Type.

getScheduledProcedureStepPriority

public java.lang.String getScheduledProcedureStepPriority()

Return ScheduledProcedureStepPriority

Returns:

String - value of ScheduledProcedureStepPriority

setScheduledProcedureStepModificationDateTime

public void setScheduledProcedureStepModificationDateTime(java.lang.String strScheduledProcedureStepModificationDateTime)

Sets Scheduled Procedure StepModification Date and Time

Parameters:

strScheduledProcedureStepModificationDateTime - String value of Scheduled Procedure StepModification Date and Time

getScheduledProcedureStepModificationDateTime

public java.lang.String getScheduledProcedureStepModificationDateTime()

Retrieves Scheduled Procedure StepModification Date and Time

Returns:

String - value of Scheduled Procedure StepModification Date and Time

setWorklistLabel

public void setWorklistLabel(java.lang.String strWorklistLabel)

Sets Worklist Label

Parameters:

strWorklistLabel - String value of Worklist Label.

getWorklistLabel

public java.lang.String getWorklistLabel()

Return Worklist Label

Returns:

String - value of Worklist Label

setProcedureStepLabel

public void setProcedureStepLabel(java.lang.String strProcedureStepLabel)

Sets Procedure Step Label

Parameters:

strProcedureStepLabel - String value of Procedure Step Label

getProcedureStepLabel

public java.lang.String getProcedureStepLabel()

Return Procedure Step Label

Returns:

String - value of Procedure Step Label

setCommentsOnTheScheduledProcedureStep

public void setCommentsOnTheScheduledProcedureStep(java.lang.String strCommentsOnTheScheduledProcedureStep)

Sets Comments on the ScheduledProcedure Step

Parameters:

strCommentsOnTheScheduledProcedureStep - String value of Comments on the ScheduledProcedure Step.

getCommentsOnTheScheduledProcedureStep

public java.lang.String getCommentsOnTheScheduledProcedureStep()

Retrieves Comments on the ScheduledProcedure Step

Returns:

String - value of Comments on the ScheduledProcedure Step

setScheduledProcedureStepStartDateTime

public void setScheduledProcedureStepStartDateTime(java.lang.String strScheduledProcedureStepStartDateTime)

Sets Scheduled Procedure Step StartDateTime

Parameters:

strScheduledProcedureStepStartDateTime - String value of Scheduled Procedure Step StartDateTime

getScheduledProcedureStepStartDateTime

public java.lang.String getScheduledProcedureStepStartDateTime()

Retrieves Scheduled Procedure Step StartDateTime

Returns:

String - value of VScheduled Procedure Step StartDateTime

setExpectedCompletionDateTime

public void setExpectedCompletionDateTime(java.lang.String strExpectedCompletionDateTime)

Sets Expected Completion DateTime

Parameters:

strExpectedCompletionDateTime - String value of Expected Completion DateTime

getExpectedCompletionDateTime

public java.lang.String getExpectedCompletionDateTime()

Retrieves Scheduled Procedure Step StartDateTime

Returns:

String - value of Expected Completion DateTime

setInputReadinessState

public void setInputReadinessState(EnumInputReadinessState enumInputReadinessState)

Sets readiness state of the Input Information Sequence (0040,4021) and the referenced instances. Enumerated Values: INCOMPLETE:The Input Information Sequence is not yet complete and additional instance references might be added. UNAVAILABLE:The Input Information Sequence is complete but one or more of the referenced instances might not yet be available from the referenced source(s). READY:The Input Information Sequence is complete and the referenced instances are available from the referenced sources.

Parameters:

enumInputReadinessState - enum value of Input Readiness State.

getInputReadinessState

public java.lang.String getInputReadinessState()

Return InputReadinessState

Returns:

String - value of InputReadinessState

setStudyInstanceUID

public void setStudyInstanceUID(java.lang.String strStudyInstanceUID)

Sets a Study Instance UID

Parameters:

strStudyInstanceUID - String value of Study Instance UID

getStudyInstanceUID

public java.lang.String getStudyInstanceUID()

Retrieves Study Instance UID

Returns:

String - value of Study Instance UID

getScheduledStationNameCodeSequence

public ScheduledStationNameCodeSequence getScheduledStationNameCodeSequence()

Retrieves pre-initialized object of Scheduled Station Name CodeSequence. 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:

ScheduledStationNameCodeSequence - instance of Scheduled Station Name CodeSequence.

getScheduledStationClassCodeSequence

public ScheduledStationClassCodeSequence getScheduledStationClassCodeSequence()

Retrieves pre-initialized object of Scheduled Station Class Code 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:

ScheduledStationClassCodeSequence - instance of Scheduled Station Class Code Sequence.

getScheduledStationGeographicLocationCodeSequence

public ScheduledStationGeographicLocationCodeSequence getScheduledStationGeographicLocationCodeSequence()

Retrieves pre-initialized object of Scheduled Station Geographic Location Code 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:

ScheduledStationGeographicLocationCodeSequence - instance of Scheduled Station Geographic Location Code Sequence.

getScheduledHumanPerformersSequence

public ScheduledHumanPerformersSequence getScheduledHumanPerformersSequence()

Retrieves pre-initialized object of Scheduled Human PerformersSequence. 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:

ScheduledHumanPerformersSequence - instance of Scheduled Human PerformersSequence

getScheduledWorkitemCodeSequence

public ScheduledWorkitemCodeSequence getScheduledWorkitemCodeSequence()

Retrieves pre-initialized object ofScheduled Workitem CodeSequence. 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:

ScheduledWorkitemCodeSequence - instance of Scheduled Workitem CodeSequence

getScheduledProcessingParametersSequence

public ScheduledProcessingParametersSequence getScheduledProcessingParametersSequence()

Retrieves pre-initialized object of Scheduled Processing ParametersSequence. 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:

ScheduledProcessingParametersSequence - instance of Scheduled Processing ParametersSequence

getInputInformationSequence

public InputInformationSequence getInputInformationSequence()

Retrieves pre-initialized object of Input Information 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:

InputInformationSequence - instance of Input Information 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