cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SRDocumentGeneralModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SRDocumentGeneralModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SRDocumentGeneralModule
extends Module

\* This module defines the general Attributes of an SR Document Instance. These Attributes identify the SR Document and provide context for the entire document.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SRDocumentGeneralModule(IDataSet objIDataSet) Creates SR Document General Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
AuthorObserverSequence	getAuthorObserverSequence() This method provides the pre-initialized object of Author Observer Sequence.
java.lang.String	getCompletionFlag() Retrieves The estimated degree of completeness of this SR Document with respect to externally defined criteria in a manner specified in the Conformance Statement.
java.lang.String	getCompletionFlagDescription() Retrieves Explanation of the value sent in Completion Flag (0040,A491).
java.lang.String	getContentDate() Retrieves The date the document content creation started.
java.lang.String	getContentTime() Retrieves The time the document content creation started.
CurrentRequestedProcedureEvidenceSequence	getCurrentRequestedProcedureEvidenceSequence() This method provides the pre-initialized object of Current Requested Procedure Evidence Sequence.
IdenticalDocumentsSequence	getIdenticalDocumentsSequence() This method provides the pre-initialized object of Identical Documents Sequence.
java.lang.String	getInstanceNumber() Retrieves a number that identifies SR Document.
ParticipantSequence	getParticipantSequence() This method provides the pre-initialized object of Participant Sequence.
PerformedProcedureCodeSequence	getPerformedProcedureCodeSequence() This method provides the pre-initialized object of Performed Procedure Code Sequence.
PertinentOtherEvidenceSequence	getPertinentOtherEvidenceSequence() This method provides the pre-initialized object of Pertinent Other Evidence Sequence.
PredecessorDocumentsSequence	getPredecessorDocumentsSequence() This method provides the pre-initialized object of Predecessor Documents Sequence.
java.lang.String	getPreliminaryFlag() Retrieves Preliminary Flag.
ReferencedInstanceSequence	getReferencedInstanceSequence() This method provides the pre-initialized object of Referenced Instance Sequence.
ReferencedRequestSequence	getReferencedRequestSequence() This method provides the pre-initialized object of Referenced Request Sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
java.lang.String	getVerificationFlag() Retrieves whether this SR Document is Verified.
VerifyingObserverSequence	getVerifyingObserverSequence() This method provides the pre-initialized object of Verifying Observer Sequence.
void	setCompletionFlag(EnumCompletionFlag enumCompletionFlag) Sets The estimated degree of completeness of this SR Document with respect to externally defined criteria in a manner specified in the Conformance Statement.
void	setCompletionFlagDescription(java.lang.String strCompletionFlagDescription) Sets Explanation of the value sent in Completion Flag (0040,A491).
void	setContentDate(java.lang.String strContentDate) Sets The date the document content creation started.
void	setContentTime(java.lang.String strContentTime) Sets The time the document content creation started.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets a number that identifies SR Document.
void	setPreliminaryFlag(EnumPreliminaryFlag enumPreliminaryFlag) Sets Preliminary Flag.
void	setVerificationFlag(EnumVerificationFlag enumVerificationFlag) Indicates whether this SR Document is Verified.
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

SRDocumentGeneralModule

public SRDocumentGeneralModule(IDataSet objIDataSet)

Creates SR Document General Module with default initialization.

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 - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets a number that identifies SR Document.

Parameters:

strInstanceNumber - String value of number that identifies SR Document

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves a number that identifies SR Document.

Returns:

String - String value of a number that identifies SR Document

setPreliminaryFlag

public void setPreliminaryFlag(EnumPreliminaryFlag enumPreliminaryFlag)

Sets Preliminary Flag. Enumerated Values: 1) PRELIMINARY 2) FINAL

Parameters:

enumPreliminaryFlag - the enum Preliminary Flag

getPreliminaryFlag

public java.lang.String getPreliminaryFlag()

Retrieves Preliminary Flag.

Returns:

String - String value of Preliminary Flag.

setCompletionFlag

public void setCompletionFlag(EnumCompletionFlag enumCompletionFlag)

Sets The estimated degree of completeness of this SR Document with respect to externally defined criteria in a manner specified in the Conformance Statement. Enumerated Values: PARTIAL = Partial content, COMPLETE = Complete content.

Parameters:

enumCompletionFlag - Enum value of Completion Flag

getCompletionFlag

public java.lang.String getCompletionFlag()

Retrieves The estimated degree of completeness of this SR Document with respect to externally defined criteria in a manner specified in the Conformance Statement.

Returns:

String - String value of Completion Flag

setCompletionFlagDescription

public void setCompletionFlagDescription(java.lang.String strCompletionFlagDescription)

Sets Explanation of the value sent in Completion Flag (0040,A491).

Parameters:

strCompletionFlagDescription - String value of Completion Flag Description

getCompletionFlagDescription

public java.lang.String getCompletionFlagDescription()

Retrieves Explanation of the value sent in Completion Flag (0040,A491).

Returns:

String - String value of Completion Flag Description

setVerificationFlag

public void setVerificationFlag(EnumVerificationFlag enumVerificationFlag)

Indicates whether this SR Document is Verified. Enumerated Values: UNVERIFIED = Not attested to. VERIFIED = Attested to by a Verifying Observer Name (0040,A075) who is accountable for its content

Parameters:

enumVerificationFlag - Enum value of Verification Flag

getVerificationFlag

public java.lang.String getVerificationFlag()

Retrieves whether this SR Document is Verified.

Returns:

String - String value of Verification Flag

setContentDate

public void setContentDate(java.lang.String strContentDate)

Sets The date the document content creation started.

Parameters:

strContentDate - String value of date

getContentDate

public java.lang.String getContentDate()

Retrieves The date the document content creation started.

Returns:

String - String value of a date

setContentTime

public void setContentTime(java.lang.String strContentTime)

Sets The time the document content creation started.

Parameters:

strContentTime - String value of time

getContentTime

public java.lang.String getContentTime()

Retrieves The time the document content creation started.

Returns:

String - String value of a time

getVerifyingObserverSequence

public VerifyingObserverSequence getVerifyingObserverSequence()

This method provides the pre-initialized object of Verifying Observer Sequence. return Verifying Observer Sequence - object of Verifying Observer 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:

the verifying observer sequence

getPredecessorDocumentsSequence

public PredecessorDocumentsSequence getPredecessorDocumentsSequence()

This method provides the pre-initialized object of Predecessor Documents Sequence. return PredecessorDocumentsSequence - object of Predecessor Documents 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:

the predecessor documents sequence

getIdenticalDocumentsSequence

public IdenticalDocumentsSequence getIdenticalDocumentsSequence()

This method provides the pre-initialized object of Identical Documents Sequence. return IdenticalDocumentsSequence - object of Identical Documents 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:

the identical documents sequence

getReferencedRequestSequence

public ReferencedRequestSequence getReferencedRequestSequence()

This method provides the pre-initialized object of Referenced Request Sequence. return ReferencedRequestSequence - object of Referenced Request 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:

the referenced request sequence

getPerformedProcedureCodeSequence

public PerformedProcedureCodeSequence getPerformedProcedureCodeSequence()

This method provides the pre-initialized object of Performed Procedure Code Sequence. return PerformedProcedureCodeSequence - object of Performed 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:

the performed procedure code sequence

getCurrentRequestedProcedureEvidenceSequence

public CurrentRequestedProcedureEvidenceSequence getCurrentRequestedProcedureEvidenceSequence()

This method provides the pre-initialized object of Current Requested Procedure Evidence Sequence. return CurrentRequestedProcedureEvidenceSequence - object of Current Requested Procedure Evidence 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:

the current requested procedure evidence sequence

getPertinentOtherEvidenceSequence

public PertinentOtherEvidenceSequence getPertinentOtherEvidenceSequence()

This method provides the pre-initialized object of Pertinent Other Evidence Sequence. return PertinentOtherEvidenceSequence - object of Pertinent Other Evidence 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:

the pertinent other evidence sequence

getAuthorObserverSequence

public AuthorObserverSequence getAuthorObserverSequence()

This method provides the pre-initialized object of Author Observer Sequence.

Returns:

- object of Author Observer 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

getParticipantSequence

public ParticipantSequence getParticipantSequence()

This method provides the pre-initialized object of Participant Sequence.

Returns:

- object of Participant 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

getReferencedInstanceSequence

public ReferencedInstanceSequence getReferencedInstanceSequence()

This method provides the pre-initialized object of Referenced Instance Sequence.

Returns:

- object of Referenced Instance 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

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:

vector of Tags - returns the vector containing the collection of tags