cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ImplantAssemblyTemplateModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImplantAssemblyTemplateModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ImplantAssemblyTemplateModule
extends Module

\* This module describes attributes in Implant Assembly Template Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ImplantAssemblyTemplateModule(IDataSet objIDataSet) Instantiates a Implant Assembly Template Module.

Method Summary

Methods

Modifier and Type	Method and Description
ComponentAssemblySequence	getComponentAssemblySequence() Retrieves pre-initialized object of Component Assembly Sequence.
ComponentTypesSequence	getComponentTypesSequence() Retrieves pre-initialized object of Component Types Sequence.
DerivationImplantAssemblyTemplateSequence	getDerivationImplantAssemblyTemplateSequence() Retrieves pre-initialized object of Derivation Implant AssemblyTemplate Sequence.
java.lang.String	getEffectiveDateTime() Retrieves Effective DateTime
ISingleCollection<byte[]>	getEncapsulatedDocument() Retrieves Encapsulated Document stream, containing a document coded according to the MIME Type.
java.lang.String	getImplantAssemblyTemplateIssuer() Return Implant Assembly Template Issuer
java.lang.String	getImplantAssemblyTemplateName() Return Implant Assembly Template Name
ImplantAssemblyTemplateTargetAnatomySequence	getImplantAssemblyTemplateTargetAnatomySequence() Retrieves pre-initialized object of Implant Assembly Template TargetAnatomy Sequence.
java.lang.String	getImplantAssemblyTemplateType() Return Implant Assembly Template Type .
java.lang.String	getImplantAssemblyTemplateVersion() Return Implant Implant Assembly TemplateVersion
java.lang.String	getMIMETypeOfEncapsulatedDocument() Return MIME Type of EncapsulatedDocument
OriginalImplantAssemblyTemplateSequence	getOriginalImplantAssemblyTemplateSequence() Retrieves pre-initialized object of Original Implant AssemblyTemplate Sequence.
ProcedureTypeCodeSequence	getProcedureTypeCodeSequence() Retrieves pre-initialized object of Procedure Type Code Sequence.
ReplacedImplantAssemblyTemplateSequence	getReplacedImplantAssemblyTemplateSequence() Retrieves pre-initialized object of Replaced Implant AssemblyTemplate Sequence.
java.lang.String	getSurgicalTechnique() Return Surgical Technique
ISingleCollection<ITag>	getVectorOfKeys() Gets the vector of keys.
void	setEffectiveDateTime(java.lang.String strEffectiveDateTime) Sets Effective DateTime
void	setEncapsulatedDocument(ISingleCollection<byte[]> vectEncapsulatedDocument) Sets Encapsulated Document stream, containing a documente coded according to the MIME Type.
void	setImplantAssemblyTemplateIssuer(java.lang.String strImplantAssemblyTemplateIssuer) Sets Implant Assembly Template Issuer
void	setImplantAssemblyTemplateName(java.lang.String strImplantAssemblyTemplateName) Sets Implant Assembly Template Name.
void	setImplantAssemblyTemplateType(EnumImplantAssemblyTemplateType enumImplantAssemblyTemplateType) Sets whether the Implant Assembly Template is derived from another Instance.
void	setImplantAssemblyTemplateVersion(java.lang.String strImplantAssemblyTemplateVersion) Sets Implant Assembly TemplateVersion
void	setMIMETypeOfEncapsulatedDocument(java.lang.String strMIMETypeOfEncapsulatedDocument) Sets MIME Type of EncapsulatedDocument
void	setSurgicalTechnique(java.lang.String strSurgicalTechnique) Sets Surgical Technique
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

ImplantAssemblyTemplateModule

public ImplantAssemblyTemplateModule(IDataSet objIDataSet)

Instantiates a Implant Assembly Template Module.

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

setEffectiveDateTime

public void setEffectiveDateTime(java.lang.String strEffectiveDateTime)

Sets Effective DateTime

Parameters:

strEffectiveDateTime - String value of Effective DateTime

getEffectiveDateTime

public java.lang.String getEffectiveDateTime()

Retrieves Effective DateTime

Returns:

String - value of Effective DateTime

setImplantAssemblyTemplateName

public void setImplantAssemblyTemplateName(java.lang.String strImplantAssemblyTemplateName)

Sets Implant Assembly Template Name.

Parameters:

strImplantAssemblyTemplateName - String value of Implant Assembly Template Name

getImplantAssemblyTemplateName

public java.lang.String getImplantAssemblyTemplateName()

Return Implant Assembly Template Name

Returns:

String - value of Implant Assembly Template Name

setImplantAssemblyTemplateIssuer

public void setImplantAssemblyTemplateIssuer(java.lang.String strImplantAssemblyTemplateIssuer)

Sets Implant Assembly Template Issuer

Parameters:

strImplantAssemblyTemplateIssuer - String value of Implant Assembly Template Issuer

getImplantAssemblyTemplateIssuer

public java.lang.String getImplantAssemblyTemplateIssuer()

Return Implant Assembly Template Issuer

Returns:

String - value of Implant Assembly Template Issuer

setImplantAssemblyTemplateVersion

public void setImplantAssemblyTemplateVersion(java.lang.String strImplantAssemblyTemplateVersion)

Sets Implant Assembly TemplateVersion

Parameters:

strImplantAssemblyTemplateVersion - String value of Implant Assembly Template Version

getImplantAssemblyTemplateVersion

public java.lang.String getImplantAssemblyTemplateVersion()

Return Implant Implant Assembly TemplateVersion

Returns:

String - value of Implant Assembly TemplateVersion

setImplantAssemblyTemplateType

public void setImplantAssemblyTemplateType(EnumImplantAssemblyTemplateType enumImplantAssemblyTemplateType)

Sets whether the Implant Assembly Template is derived from another Instance. Enumerated Values: ORIGINAL DERIVED

Parameters:

enumImplantAssemblyTemplateType - enum value of Implant Assembly Template Type .

getImplantAssemblyTemplateType

public java.lang.String getImplantAssemblyTemplateType()

Return Implant Assembly Template Type .

Returns:

String - value of Implant Assembly Template Type.

setSurgicalTechnique

public void setSurgicalTechnique(java.lang.String strSurgicalTechnique)

Sets Surgical Technique

Parameters:

strSurgicalTechnique - String value of Surgical Technique

getSurgicalTechnique

public java.lang.String getSurgicalTechnique()

Return Surgical Technique

Returns:

String - value of Surgical Technique

setMIMETypeOfEncapsulatedDocument

public void setMIMETypeOfEncapsulatedDocument(java.lang.String strMIMETypeOfEncapsulatedDocument)

Sets MIME Type of EncapsulatedDocument

Parameters:

strMIMETypeOfEncapsulatedDocument - String value of MIME Type of EncapsulatedDocument

getMIMETypeOfEncapsulatedDocument

public java.lang.String getMIMETypeOfEncapsulatedDocument()

Return MIME Type of EncapsulatedDocument

Returns:

String - value of MIME Type of EncapsulatedDocument

setEncapsulatedDocument

public void setEncapsulatedDocument(ISingleCollection<byte[]> vectEncapsulatedDocument)

Sets Encapsulated Document stream, containing a documente coded according to the MIME Type.

Parameters:

vectEncapsulatedDocument - collection of byte array of Encapsulated Document

getEncapsulatedDocument

public ISingleCollection<byte[]> getEncapsulatedDocument()

Retrieves Encapsulated Document stream, containing a document coded according to the MIME Type.

Returns:

ISingleCollection - collection of byte array of Encapsulated Document

getReplacedImplantAssemblyTemplateSequence

public ReplacedImplantAssemblyTemplateSequence getReplacedImplantAssemblyTemplateSequence()

Retrieves pre-initialized object of Replaced Implant AssemblyTemplate 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:

ReplacedImplantAssemblyTemplateSequence - Replaced Implant AssemblyTemplate Sequence.

getOriginalImplantAssemblyTemplateSequence

public OriginalImplantAssemblyTemplateSequence getOriginalImplantAssemblyTemplateSequence()

Retrieves pre-initialized object of Original Implant AssemblyTemplate 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:

OriginalImplantAssemblyTemplateSequence - Original Implant AssemblyTemplate Sequence.

getDerivationImplantAssemblyTemplateSequence

public DerivationImplantAssemblyTemplateSequence getDerivationImplantAssemblyTemplateSequence()

Retrieves pre-initialized object of Derivation Implant AssemblyTemplate 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:

DerivationImplantAssemblyTemplateSequence - Derivation Implant AssemblyTemplate Sequence.

getImplantAssemblyTemplateTargetAnatomySequence

public ImplantAssemblyTemplateTargetAnatomySequence getImplantAssemblyTemplateTargetAnatomySequence()

Retrieves pre-initialized object of Implant Assembly Template TargetAnatomy 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:

ImplantAssemblyTemplateTargetAnatomySequence - Implant Assembly Template TargetAnatomy Sequence

getProcedureTypeCodeSequence

public ProcedureTypeCodeSequence getProcedureTypeCodeSequence()

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

ProcedureTypeCodeSequence - Procedure Type Code Sequence

getComponentTypesSequence

public ComponentTypesSequence getComponentTypesSequence()

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

ComponentTypesSequence - Component Types Sequence

getComponentAssemblySequence

public ComponentAssemblySequence getComponentAssemblySequence()

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

ComponentAssemblySequence - Component Assembly 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