cdac.medinfo.sdk.dcm30_04.baselibs

Class PerformedProcedureStepSummaryMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.PerformedProcedureStepSummaryMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class PerformedProcedureStepSummaryMacro
extends Macro

This class contains Macro that describes attributes of the Performed Procedure Step Summary.

Author:

saloni

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PerformedProcedureStepSummaryMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
PerformedProcedureStepSummaryMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
PerformedProcedureStepSummaryMacro(IItem objItem) This constructor constructs a Macro with the specified Item
PerformedProcedureStepSummaryMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCommentsOnThePerformedProcedureStep() Retrieves the User-defined comments on the Performed ProcedureStep.
java.lang.String	getPerformedProcedureStepDescription() Return Performed Procedure StepDescription
java.lang.String	getPerformedProcedureStepEndDate() Retrieves Performed Procedure Step EndDate
java.lang.String	getPerformedProcedureStepEndTime() Retrieves Performed Procedure Step EndTime
java.lang.String	getPerformedProcedureStepID() Retrieves Performed Procedure Step ID
java.lang.String	getPerformedProcedureStepStartDate() Retrieves Performed Procedure Step StartDate
java.lang.String	getPerformedProcedureStepStartTime() Retrieves Performed Procedure Step StartTime
PerformedProtocolCodeSequence	getPerformedProtocolCodeSequence() Retrieves pre-initialized object of Performed Protocol 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.
void	setCommentsOnThePerformedProcedureStep(java.lang.String strCommentsOnThePerformedProcedureStep) Sets the User-defined comments on the Performed ProcedureStep.
void	setPerformedProcedureStepDescription(java.lang.String strPerformedProcedureStepDescription) Sets Performed Procedure StepDescription
void	setPerformedProcedureStepEndDate(java.lang.String strPerformedProcedureStepEndDate) Sets Performed Procedure Step EndDate
void	setPerformedProcedureStepEndTime(java.lang.String strPerformedProcedureStepEndTime) Sets Performed Procedure Step EndTime
void	setPerformedProcedureStepID(java.lang.String strPerformedProcedureStepID) Sets the Performed Procedure Step ID.
void	setPerformedProcedureStepStartDate(java.lang.String strPerformedProcedureStepStartDate) Sets Performed Procedure Step StartDate
void	setPerformedProcedureStepStartTime(java.lang.String strPerformedProcedureStepStartTime) Sets Performed Procedure Step StartTime
boolean	validate() Validates all the attributes in PersonIdentificationMacro
boolean	validate(IDataSet objIDataSet) Validates all the attributes in PersonIdentificationMacro that are present in the DataSet
boolean	validate(IItem objIItem) Validates all the attributes in PersonIdentificationMacro that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Macro

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

PerformedProcedureStepSummaryMacro

public PerformedProcedureStepSummaryMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

PerformedProcedureStepSummaryMacro

public PerformedProcedureStepSummaryMacro(IDataSet objDataSet,
                                  IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

PerformedProcedureStepSummaryMacro

public PerformedProcedureStepSummaryMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

PerformedProcedureStepSummaryMacro

public PerformedProcedureStepSummaryMacro(IItem objItem,
                                  IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in PersonIdentificationMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public boolean validate(IItem objIItem)
                 throws InvalidMacroException

Validates all the attributes in PersonIdentificationMacro that are present in the DataSet

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

int - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public boolean validate(IDataSet objIDataSet)
                 throws InvalidMacroException

Validates all the attributes in PersonIdentificationMacro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

int - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

setPerformedProcedureStepID

public void setPerformedProcedureStepID(java.lang.String strPerformedProcedureStepID)

Sets the Performed Procedure Step ID.

Parameters:

strPerformedProcedureStepID -

getPerformedProcedureStepID

public java.lang.String getPerformedProcedureStepID()

Retrieves Performed Procedure Step ID

Returns:

String - value of Performed Procedure Step ID

setPerformedProcedureStepStartDate

public void setPerformedProcedureStepStartDate(java.lang.String strPerformedProcedureStepStartDate)

Sets Performed Procedure Step StartDate

Parameters:

strPerformedProcedureStepStartDate - String value of Performed Procedure Step StartDate

getPerformedProcedureStepStartDate

public java.lang.String getPerformedProcedureStepStartDate()

Retrieves Performed Procedure Step StartDate

Returns:

String - value of Performed Procedure Step StartDate

setPerformedProcedureStepStartTime

public void setPerformedProcedureStepStartTime(java.lang.String strPerformedProcedureStepStartTime)

Sets Performed Procedure Step StartTime

Parameters:

strPerformedProcedureStepStartTime - String of Performed Procedure Step StartTime

getPerformedProcedureStepStartTime

public java.lang.String getPerformedProcedureStepStartTime()

Retrieves Performed Procedure Step StartTime

Returns:

String - value of Performed Procedure Step StartTime

setPerformedProcedureStepEndDate

public void setPerformedProcedureStepEndDate(java.lang.String strPerformedProcedureStepEndDate)

Sets Performed Procedure Step EndDate

Parameters:

strPerformedProcedureStepEndDate - String value of Performed Procedure Step EndDate

getPerformedProcedureStepEndDate

public java.lang.String getPerformedProcedureStepEndDate()

Retrieves Performed Procedure Step EndDate

Returns:

String - value of Performed Procedure Step EndDate

setPerformedProcedureStepEndTime

public void setPerformedProcedureStepEndTime(java.lang.String strPerformedProcedureStepEndTime)

Sets Performed Procedure Step EndTime

Parameters:

strPerformedProcedureStepEndTime - String of Performed Procedure Step EndTime

getPerformedProcedureStepEndTime

public java.lang.String getPerformedProcedureStepEndTime()

Retrieves Performed Procedure Step EndTime

Returns:

String - value of Performed Procedure Step EndTime

setPerformedProcedureStepDescription

public void setPerformedProcedureStepDescription(java.lang.String strPerformedProcedureStepDescription)

Sets Performed Procedure StepDescription

Parameters:

strPerformedProcedureStepDescription - String value of Performed Procedure StepDescription

getPerformedProcedureStepDescription

public java.lang.String getPerformedProcedureStepDescription()

Return Performed Procedure StepDescription

Returns:

String - value of Performed Procedure StepDescription.

getPerformedProtocolCodeSequence

public PerformedProtocolCodeSequence getPerformedProtocolCodeSequence()

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

PerformedProtocolCodeSequence - instance of PerformedProtocolCodeSequence.

setCommentsOnThePerformedProcedureStep

public void setCommentsOnThePerformedProcedureStep(java.lang.String strCommentsOnThePerformedProcedureStep)

Sets the User-defined comments on the Performed ProcedureStep.

Parameters:

strCommentsOnThePerformedProcedureStep - User-defined comments on the Performed ProcedureStep.

getCommentsOnThePerformedProcedureStep

public java.lang.String getCommentsOnThePerformedProcedureStep()

Retrieves the User-defined comments on the Performed ProcedureStep.

Returns:

String value of Radiation Dose for User-defined comments on the Performed ProcedureStep.