cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class GeneralPurposeScheduledProcedureStepInformationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralPurposeScheduledProcedureStepInformationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class GeneralPurposeScheduledProcedureStepInformationModule
extends Module

\* This module specifies the Attributes that identify the General Purpose Scheduled Procedure Step 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
GeneralPurposeScheduledProcedureStepInformationModule(IDataSet objIDataSet) Instantiates a new general purpose scheduled procedure step information module.

Method Summary

Methods

Modifier and Type	Method and Description
ActualHumanPerformersSequence	getActualHumanPerformersSequence() Retrieves pre-initialized object of Actual Human Performers Sequence.
java.lang.String	getCommentsOnTheScheduledProcedureStep() Retrieves User-defined comments on the Scheduled Procedure Step.
java.lang.String	getExpectedCompletionDateAndTime() Retrieves Date on which the Procedure Step is expected to be completed.
java.lang.String	getGeneralPurposeScheduledProcedureStepPriority() Retrieves GScheduled Procedure Step priority.
java.lang.String	getGeneralPurposeScheduledProcedureStepStatus() Retrieves General Purpose Scheduled Procedure Step Status.
java.lang.String	getInputAvailabilityFlag() Retrieves Flag that indicates the availability of Composite SOP Instances in the Attribute Input Information Sequence (0040,4021) of the General Purpose Scheduled Procedure Step.
InputInformationSequence	getInputInformationSequence() Retrieves pre-initialized object of Input Information Sequence.
java.lang.String	getMultipleCopiesFlag() Retrieves flag that indicates that multiple copies have to be made of a Composite SOP Instance that supports the notion of multiple copies.
ReferencedPerformedProcedureStepSequence	getReferencedPerformedProcedureStepSequence() Retrieves pre-initialized object of Referenced Performed Procedure Step Sequence.
RelevantInformationSequence	getRelevantInformationSequence() Retrieves pre-initialized object of Relevant Information Sequence.
ResultingGeneralPurposePerformedProcedureStepsSequence	getResultingGeneralPurposePerformedProcedureStepsSequence() Retrieves pre-initialized object of Resulting General Purpose Performed Procedure Steps Sequence.
ScheduledHumanPerformersSequence	getScheduledHumanPerformersSequence() Retrieves pre-initialized object of Scheduled Human Performers Sequence.
java.lang.String	getScheduledProcedureStepID() Retrieves Identifier that identifies the Scheduled General Purpose Procedure Step.
java.lang.String	getScheduledProcedureStepModificationDateAndTime() Retrieves Date and time when the General Purpose Scheduled Procedure Step was last modified or first created.
java.lang.String	getScheduledProcedureStepStartDateAndTime() Retrieves Date and time on which the General Purpose Scheduled Procedure Step is scheduled to start.
ScheduledProcessingApplicationsCodeSequence	getScheduledProcessingApplicationsCodeSequence() Retrieves pre-initialized object of Scheduled Processing Applications 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
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
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
ScheduledStationNameCodeSequence	getScheduledStationNameCodeSequence() Retrieves pre-initialized object of Scheduled Station Name 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
ScheduledWorkitemCodeSequence	getScheduledWorkitemCodeSequence() Retrieves pre-initialized object of Scheduled Workitem Code Sequence.
java.lang.String	getStudyInstanceUID() Retrieves Unique Study identification that shall be used for the created Composite SOP Instances resulting from this General Purpose Scheduled Procedure Step.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setCommentsOnTheScheduledProcedureStep(java.lang.String strCommentsOnTheScheduledProcedureStep) Sets User-defined comments on the Scheduled Procedure Step.
void	setExpectedCompletionDateAndTime(java.lang.String strExpectedCompletionDateAndTime) Sets Date on which the Procedure Step is expected to be completed.
void	setGeneralPurposeScheduledProcedureStepPriority(EnumGeneralPurposeScheduledProcedureStepPriority enumGeneralPurposeScheduledProcedureStepPriority) Sets Scheduled Procedure Step priority.
void	setGeneralPurposeScheduledProcedureStepStatus(EnumGeneralPurposeScheduledProcedureStepStatus enumGeneralPurposeScheduledProcedureStepStatus) Sets A status that informs the operator and the worklist management system about the progress of the scheduled General Purpose procedure step.
void	setInputAvailabilityFlag(EnumInputAvailabilityFlag enumInputAvailabilityFlag) Sets Flag that indicates the availability of Composite SOP Instances in the Attribute Input Information Sequence (0040,4021) of the General Purpose Scheduled Procedure Step.
void	setMultipleCopiesFlag(EnumMultipleCopiesFlag enumMultipleCopiesFlag) This flag indicates that multiple copies have to be made of a Composite SOP Instance that supports the notion of multiple copies.
void	setScheduledProcedureStepID(java.lang.String strScheduledProcedureStepID) Sets Identifier that identifies the Scheduled General Purpose Procedure Step.
void	setScheduledProcedureStepModificationDateAndTime(java.lang.String strScheduledProcedureStepModificationDateAndTime) Sets Date and time when the General Purpose Scheduled Procedure Step was last modified or first created.
void	setScheduledProcedureStepStartDateAndTime(java.lang.String strScheduledProcedureStepStartDateAndTime) Sets Date and time on which the General Purpose Scheduled Procedure Step is scheduled to start.
void	setStudyInstanceUID(java.lang.String strStudyInstanceUID) Sets Unique Study identification that shall be used for the created Composite SOP Instances resulting from this General Purpose Scheduled Procedure Step.
boolean	validateModule() Validates each Attribute in the Module according to the Type of the Attribute.

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

GeneralPurposeScheduledProcedureStepInformationModule

public GeneralPurposeScheduledProcedureStepInformationModule(IDataSet objIDataSet)

Instantiates a new general purpose scheduled procedure step information 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 - - If validation of Module fails

setGeneralPurposeScheduledProcedureStepStatus

public void setGeneralPurposeScheduledProcedureStepStatus(EnumGeneralPurposeScheduledProcedureStepStatus enumGeneralPurposeScheduledProcedureStepStatus)

Sets A status that informs the operator and the worklist management system about the progress of the scheduled General Purpose procedure step. Enumerated Values are: SCHEDULED, IN PROGRESS, SUSPENDED, COMPLETED, DISCONTINUED.

Parameters:

enumGeneralPurposeScheduledProcedureStepStatus - the enum general purpose scheduled procedure step status

getGeneralPurposeScheduledProcedureStepStatus

public java.lang.String getGeneralPurposeScheduledProcedureStepStatus()

Retrieves General Purpose Scheduled Procedure Step Status.

Returns:

String - String value of General Purpose Scheduled Procedure Step Status.

setGeneralPurposeScheduledProcedureStepPriority

public void setGeneralPurposeScheduledProcedureStepPriority(EnumGeneralPurposeScheduledProcedureStepPriority enumGeneralPurposeScheduledProcedureStepPriority)

Sets Scheduled Procedure Step priority. Enumerated Values are: 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 HIGH and higher than LOW. LOW: used to indicate a routine or non-urgent work item.

Parameters:

enumGeneralPurposeScheduledProcedureStepPriority - the enum general purpose scheduled procedure step priority

getGeneralPurposeScheduledProcedureStepPriority

public java.lang.String getGeneralPurposeScheduledProcedureStepPriority()

Retrieves GScheduled Procedure Step priority.

Returns:

String - String value of Scheduled Procedure Step priority.

setScheduledProcedureStepID

public void setScheduledProcedureStepID(java.lang.String strScheduledProcedureStepID)

Sets Identifier that identifies the Scheduled General Purpose Procedure Step.

Parameters:

strScheduledProcedureStepID - String value of Scheduled Procedure Step ID

getScheduledProcedureStepID

public java.lang.String getScheduledProcedureStepID()

Retrieves Identifier that identifies the Scheduled General Purpose Procedure Step.

Returns:

String - String value of Scheduled Procedure Step ID

setScheduledProcedureStepModificationDateAndTime

public void setScheduledProcedureStepModificationDateAndTime(java.lang.String strScheduledProcedureStepModificationDateAndTime)

Sets Date and time when the General Purpose Scheduled Procedure Step was last modified or first created.

Parameters:

strScheduledProcedureStepModificationDateAndTime - String value of Scheduled Procedure Step Modification Date and Time

getScheduledProcedureStepModificationDateAndTime

public java.lang.String getScheduledProcedureStepModificationDateAndTime()

Retrieves Date and time when the General Purpose Scheduled Procedure Step was last modified or first created.

Returns:

String - String value of Scheduled Procedure Step Modification Date and Time

getScheduledStationNameCodeSequence

public ScheduledStationNameCodeSequence getScheduledStationNameCodeSequence()

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

ScheduledStationNameCodeSequence - instance of Scheduled Station Name Code Sequence

getScheduledProcessingApplicationsCodeSequence

public ScheduledProcessingApplicationsCodeSequence getScheduledProcessingApplicationsCodeSequence()

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

ScheduledProcessingApplicationsCodeSequence - instance of Scheduled Processing Applications Code Sequence.

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 Performers 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:

ScheduledHumanPerformersSequence - instance of Scheduled Human Performers Sequence.

setScheduledProcedureStepStartDateAndTime

public void setScheduledProcedureStepStartDateAndTime(java.lang.String strScheduledProcedureStepStartDateAndTime)

Sets Date and time on which the General Purpose Scheduled Procedure Step is scheduled to start.

Parameters:

strScheduledProcedureStepStartDateAndTime - String value of Scheduled Procedure Step Start Date and Time

getScheduledProcedureStepStartDateAndTime

public java.lang.String getScheduledProcedureStepStartDateAndTime()

Retrieves Date and time on which the General Purpose Scheduled Procedure Step is scheduled to start.

Returns:

String - String value of Scheduled Procedure Step Start Date and Time.

setExpectedCompletionDateAndTime

public void setExpectedCompletionDateAndTime(java.lang.String strExpectedCompletionDateAndTime)

Sets Date on which the Procedure Step is expected to be completed.

Parameters:

strExpectedCompletionDateAndTime - String value of Expected Completion Date and Time

getExpectedCompletionDateAndTime

public java.lang.String getExpectedCompletionDateAndTime()

Retrieves Date on which the Procedure Step is expected to be completed.

Returns:

String - String value of Expected Completion Date and Time

getScheduledWorkitemCodeSequence

public ScheduledWorkitemCodeSequence getScheduledWorkitemCodeSequence()

Retrieves pre-initialized object of Scheduled Workitem 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:

ScheduledWorkitemCodeSequence. - instance of Scheduled Workitem Code Sequence.

setCommentsOnTheScheduledProcedureStep

public void setCommentsOnTheScheduledProcedureStep(java.lang.String strCommentsOnTheScheduledProcedureStep)

Sets User-defined comments on the Scheduled Procedure Step.

Parameters:

strCommentsOnTheScheduledProcedureStep - String value of Comments on the Scheduled Procedure Step

getCommentsOnTheScheduledProcedureStep

public java.lang.String getCommentsOnTheScheduledProcedureStep()

Retrieves User-defined comments on the Scheduled Procedure Step.

Returns:

String - String value of Comments on the Scheduled Procedure Step

getReferencedPerformedProcedureStepSequence

public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()

Retrieves pre-initialized object of Referenced Performed Procedure Step 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:

ReferencedPerformedProcedureStepSequence - instance of Referenced Performed Procedure Step Sequence.

setInputAvailabilityFlag

public void setInputAvailabilityFlag(EnumInputAvailabilityFlag enumInputAvailabilityFlag)

Sets Flag that indicates the availability of Composite SOP Instances in the Attribute Input Information Sequence (0040,4021) of the General Purpose Scheduled Procedure Step. Enumerated values are: PARTIAL,COMPLETE

Parameters:

enumInputAvailabilityFlag - the enum input availability flag

getInputAvailabilityFlag

public java.lang.String getInputAvailabilityFlag()

Retrieves Flag that indicates the availability of Composite SOP Instances in the Attribute Input Information Sequence (0040,4021) of the General Purpose Scheduled Procedure Step.

Returns:

String - String value of Input Availability Flag

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.

getRelevantInformationSequence

public RelevantInformationSequence getRelevantInformationSequence()

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

RelevantInformationSequence - instance of Relevant Information Sequence.

setStudyInstanceUID

public void setStudyInstanceUID(java.lang.String strStudyInstanceUID)

Sets Unique Study identification that shall be used for the created Composite SOP Instances resulting from this General Purpose Scheduled Procedure Step.

Parameters:

strStudyInstanceUID - Unique identifier for the Study.

getStudyInstanceUID

public java.lang.String getStudyInstanceUID()

Retrieves Unique Study identification that shall be used for the created Composite SOP Instances resulting from this General Purpose Scheduled Procedure Step.

Returns:

String - String value of Study Instance UID

setMultipleCopiesFlag

public void setMultipleCopiesFlag(EnumMultipleCopiesFlag enumMultipleCopiesFlag)

This flag indicates that multiple copies have to be made of a Composite SOP Instance that supports the notion of multiple copies. This includes the SR SOP Class. If set the Study Instance UIDs in the Referenced Request Sequence (0040,A370) shall be used for the created multiple copies.

Parameters:

enumMultipleCopiesFlag - the enum multiple copies flag

getMultipleCopiesFlag

public java.lang.String getMultipleCopiesFlag()

Retrieves flag that indicates that multiple copies have to be made of a Composite SOP Instance that supports the notion of multiple copies.

Returns:

String - String value of Multiple Copies Flag.

getResultingGeneralPurposePerformedProcedureStepsSequence

public ResultingGeneralPurposePerformedProcedureStepsSequence getResultingGeneralPurposePerformedProcedureStepsSequence()

Retrieves pre-initialized object of Resulting General Purpose Performed Procedure Steps 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:

ResultingGeneralPurposePerformedProcedureStepsSequence - instance of Resulting General Purpose Performed Procedure Steps Sequence.

getActualHumanPerformersSequence

public ActualHumanPerformersSequence getActualHumanPerformersSequence()

Retrieves pre-initialized object of Actual Human Performers 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:

ActualHumanPerformersSequence - instance of Actual Human Performers Sequence

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:

Collection of tags - returns the vector containing the collection of tags.