cdac.medinfo.sdk.dcm30_04.baselibs

Class RequestAttributesMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.RequestAttributesMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class RequestAttributesMacro
extends Macro

This class contains the getter setter methods and validate method for Request Attributes Macro .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RequestAttributesMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
RequestAttributesMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
RequestAttributesMacro(IItem objItem) This constructor constructs a Macro with the specified Item
RequestAttributesMacro(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	getAccessionNumber() Return attribute identifies A departmental IS generated number that identifies the order for the Study.
ContentItemModifierSequence	getContentItemModifierSequence() Retrieves pre-initialized object of Content Item Modifier 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.
IssuerofAccessionNumberSequence	getIssuerofAccessionNumberSequence() Retrieves pre-initialized object of Issuer of Accession NumberSequence.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.
ProtocolContextSequence	getProtocolContextSequence() Retrieves pre-initialized object of Protocol Context 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.
ReasonForRequestedProcedureCodeSequence	getReasonForRequestedProcedureCodeSequence() Retrieves pre-initialized object of Reason For Requested Procedure 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.
java.lang.String	getReasonForTheRequestedProcedure() Retrieves reason for the Requested Procedure.
ReferencedStudySequence	getReferencedStudySequence() Retrieves pre-initialized object of Referenced Study 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
java.lang.String	getRequestedProcedureDescription() Return Institution-generated administrative description or classification of Requested Procedure.
java.lang.String	getRequestedProcedureID() Retrieves Requested Procedure ID.
java.lang.String	getScheduledProcedureStepDescription() Retrieves Scheduled Procedure Step Description.
java.lang.String	getScheduledProcedureStepID() Retrieves Scheduled Procedure Step ID.
ScheduledProtocolCodeSequence	getScheduledProtocolCodeSequence() Retrieves pre-initialized object of Scheduled 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.
java.lang.String	getStudyInstanceUID() Return Unique identifier for the Study.
void	setAccessionNumber(java.lang.String StrAccessionNumber) Sets attribute identifies A departmental IS generated number that identifies the order for the Study.
void	setReasonForTheRequestedProcedure(java.lang.String strReasonForTheRequestedProcedure) Sets reason for the Requested Procedure.
void	setRequestedProcedureDescription(java.lang.String StrRequestedProcedureDescription) Sets Institution-generated administrative description or classification of Requested Procedure.
void	setRequestedProcedureID(java.lang.String strRequestedProcedureID) Sets the Requested Procedure ID in string format.
void	setScheduledProcedureStepDescription(java.lang.String strScheduledProcedureStepDescription) Sets Scheduled Procedure Step Description.
void	setScheduledProcedureStepID(java.lang.String strScheduledProcedureStepID) Sets Scheduled Procedure Step ID.
void	setStudyInstanceUID(java.lang.String StrStudyInstanceUID) Sets attribute Unique identifier for the Study.
boolean	validate() Validates all the attributes in RequestAttributesMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in RequestAttributesMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in RequestAttributesMacro 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

RequestAttributesMacro

public RequestAttributesMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

RequestAttributesMacro

public RequestAttributesMacro(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

RequestAttributesMacro

public RequestAttributesMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

RequestAttributesMacro

public RequestAttributesMacro(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 RequestAttributesMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

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

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

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

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

setRequestedProcedureID

public void setRequestedProcedureID(java.lang.String strRequestedProcedureID)

Sets the Requested Procedure ID in string format.

Parameters:

strRequestedProcedureID - String value of Requested Procedure ID.

getRequestedProcedureID

public java.lang.String getRequestedProcedureID()

Retrieves Requested Procedure ID.

Returns:

String - value of Requested Procedure ID.

setReasonForTheRequestedProcedure

public void setReasonForTheRequestedProcedure(java.lang.String strReasonForTheRequestedProcedure)

Sets reason for the Requested Procedure.

Parameters:

strReasonForTheRequestedProcedure - String value of reason for the Requested Procedure.

getReasonForTheRequestedProcedure

public java.lang.String getReasonForTheRequestedProcedure()

Retrieves reason for the Requested Procedure.

Returns:

String - value of reason for the Requested Procedure.

getReasonForRequestedProcedureCodeSequence

public ReasonForRequestedProcedureCodeSequence getReasonForRequestedProcedureCodeSequence()

Retrieves pre-initialized object of Reason For Requested Procedure 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:

ReasonForRequestedProcedureCodeSequence - instance of ReasonForRequestedProcedureCodeSequence.

setScheduledProcedureStepID

public void setScheduledProcedureStepID(java.lang.String strScheduledProcedureStepID)

Sets Scheduled Procedure Step ID.

Parameters:

strScheduledProcedureStepID - String value of Scheduled Procedure Step ID.

getScheduledProcedureStepID

public java.lang.String getScheduledProcedureStepID()

Retrieves Scheduled Procedure Step ID.

Returns:

String - value of Scheduled Procedure Step ID.

setScheduledProcedureStepDescription

public void setScheduledProcedureStepDescription(java.lang.String strScheduledProcedureStepDescription)

Sets Scheduled Procedure Step Description.

Parameters:

strScheduledProcedureStepDescription - String value of Scheduled Procedure Step Description.

getScheduledProcedureStepDescription

public java.lang.String getScheduledProcedureStepDescription()

Retrieves Scheduled Procedure Step Description.

Returns:

String - value of Scheduled Procedure Step Description.

getScheduledProtocolCodeSequence

public ScheduledProtocolCodeSequence getScheduledProtocolCodeSequence()

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

ScheduledProtocolCodeSequence - instance of ScheduledProtocolCodeSequence.

setAccessionNumber

public void setAccessionNumber(java.lang.String StrAccessionNumber)

Sets attribute identifies A departmental IS generated number that identifies the order for the Study.

Parameters:

StrAccessionNumber - String identifies departmental IS generated number

getAccessionNumber

public java.lang.String getAccessionNumber()

Return attribute identifies A departmental IS generated number that identifies the order for the Study.

Returns:

String - identifies departmental IS generated number

setStudyInstanceUID

public void setStudyInstanceUID(java.lang.String StrStudyInstanceUID)

Sets attribute Unique identifier for the Study.

Parameters:

StrStudyInstanceUID - String Unique identifier

getStudyInstanceUID

public java.lang.String getStudyInstanceUID()

Return Unique identifier for the Study.

Returns:

String - Unique identifier.

getReferencedStudySequence

public ReferencedStudySequence getReferencedStudySequence()

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

ReferencedStudySequence - instance of Referenced Study Sequence

setRequestedProcedureDescription

public void setRequestedProcedureDescription(java.lang.String StrRequestedProcedureDescription)

Sets Institution-generated administrative description or classification of Requested Procedure.

Parameters:

StrRequestedProcedureDescription - String Institution-generated administrative description

getRequestedProcedureDescription

public java.lang.String getRequestedProcedureDescription()

Return Institution-generated administrative description or classification of Requested Procedure.

Returns:

String - Institution-generated administrative description

getIssuerofAccessionNumberSequence

public IssuerofAccessionNumberSequence getIssuerofAccessionNumberSequence()

Retrieves pre-initialized object of Issuer of Accession NumberSequence.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:

IssuerofAccessionNumberSequence - instance of IssuerofAccessionNumberSequence.

getProtocolContextSequence

public ProtocolContextSequence getProtocolContextSequence()

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

ProtocolContextSequence - instance of ProtocolContextSequence.

getContentItemModifierSequence

public ContentItemModifierSequence getContentItemModifierSequence()

Retrieves pre-initialized object of Content Item Modifier 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:

ContentItemModifierSequence - instance of ContentItemModifierSequence.