cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ClinicalTrialSubjectModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ClinicalTrialSubjectModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ClinicalTrialSubjectModule
extends Module

\* This module specifies attributes that identify a Patient as a clinical trial Subject.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ClinicalTrialSubjectModule(IDataSet objIDataSet) Instantiates a new clinical trial subject module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClinicalTrialProtocolEthicsCommitteeApprovalNumber() Gets the Clinical Trial Protocol Ethics Committee Approval Number.
java.lang.String	getClinicalTrialProtocolEthicsCommitteeName() Gets the Clinical Trial Protocol Ethics Committee Name.
java.lang.String	getClinicalTrialProtocolID() Gets the clinical trial protocol id.
java.lang.String	getClinicalTrialProtocolName() Gets the clinical trial protocol name.
java.lang.String	getClinicalTrialSiteID() Gets the clinical trial site id.
java.lang.String	getClinicalTrialSiteName() Gets the clinical trial site name.
java.lang.String	getClinicalTrialSponsorName() Gets the clinical trial sponsor name.
java.lang.String	getClinicalTrialSubjectID() Gets the clinical trial subject id.
java.lang.String	getClinicalTrialSubjectReadingID() Gets the clinical trial subject reading id.
ISingleCollection<ITag>	getVectorOfKeys() Gets the vector of keys.
void	setClinicalTrialProtocolEthicsCommitteeApprovalNumber(java.lang.String strClinicalTrialProtocolEthicsCommitteeApprovalNumber) The method is used to set Clinical Trial Protocol Ethics Committee Approval Number.
void	setClinicalTrialProtocolEthicsCommitteeName(java.lang.String strClinicalTrialProtocolEthicsCommitteeName) The method is used to set Clinical Trial Protocol Ethics Committee Name.
void	setClinicalTrialProtocolID(java.lang.String strClinicalTrialProtocolID) The method is used to set The Identifier for the noted protocol.
void	setClinicalTrialProtocolName(java.lang.String strClinicalTrialProtocolName) The method is used to set The name of the clinical trial protocol.
void	setClinicalTrialSiteID(java.lang.String strClinicalTrialSiteID) The method is used to set The identifier of the site responsible for submitting clinical trial data.
void	setClinicalTrialSiteName(java.lang.String strClinicalTrialSiteName) The method is used to set The name of the site responsible for submitting clinical trial data.
void	setClinicalTrialSponsorName(java.lang.String strClinicalTrialSponsorName) The method is used to set The name of the clinical trial sponsor.
void	setClinicalTrialSubjectID(java.lang.String strClinicalTrialSubjectID) The method is used to set identifier for the clinical trial subject.
void	setClinicalTrialSubjectReadingID(java.lang.String strClinicalTrialSubjectReadingID) The method is used to set identifier for subject for blinded evaluations.
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

ClinicalTrialSubjectModule

public ClinicalTrialSubjectModule(IDataSet objIDataSet)

Instantiates a new clinical trial subject 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

setClinicalTrialSponsorName

public void setClinicalTrialSponsorName(java.lang.String strClinicalTrialSponsorName)

The method is used to set The name of the clinical trial sponsor.

Parameters:

strClinicalTrialSponsorName - : The name of the clinical trial sponsor.

setClinicalTrialProtocolID

public void setClinicalTrialProtocolID(java.lang.String strClinicalTrialProtocolID)

The method is used to set The Identifier for the noted protocol.

Parameters:

strClinicalTrialProtocolID - the str clinical trial protocol id

setClinicalTrialProtocolName

public void setClinicalTrialProtocolName(java.lang.String strClinicalTrialProtocolName)

The method is used to set The name of the clinical trial protocol.

Parameters:

strClinicalTrialProtocolName - the str clinical trial protocol name

setClinicalTrialSiteID

public void setClinicalTrialSiteID(java.lang.String strClinicalTrialSiteID)

The method is used to set The identifier of the site responsible for submitting clinical trial data.

Parameters:

strClinicalTrialSiteID - :The ID of the site responsible for submitting clinical trial data..

setClinicalTrialSiteName

public void setClinicalTrialSiteName(java.lang.String strClinicalTrialSiteName)

The method is used to set The name of the site responsible for submitting clinical trial data.

Parameters:

strClinicalTrialSiteName - :The name of the site responsible for submitting clinical trial data..

setClinicalTrialSubjectID

public void setClinicalTrialSubjectID(java.lang.String strClinicalTrialSubjectID)

The method is used to set identifier for the clinical trial subject. submitting clinical trial data.

Parameters:

strClinicalTrialSubjectID - :The identifier for the clinical trial subject.

setClinicalTrialSubjectReadingID

public void setClinicalTrialSubjectReadingID(java.lang.String strClinicalTrialSubjectReadingID)

The method is used to set identifier for subject for blinded evaluations. submitting clinical trial data.

Parameters:

strClinicalTrialSubjectReadingID - :The identifier for subject for blinded evaluations

setClinicalTrialProtocolEthicsCommitteeName

public void setClinicalTrialProtocolEthicsCommitteeName(java.lang.String strClinicalTrialProtocolEthicsCommitteeName)

The method is used to set Clinical Trial Protocol Ethics Committee Name.

Parameters:

strClinicalTrialProtocolEthicsCommitteeName - value Clinical Trial Protocol Ethics Committee Name

setClinicalTrialProtocolEthicsCommitteeApprovalNumber

public void setClinicalTrialProtocolEthicsCommitteeApprovalNumber(java.lang.String strClinicalTrialProtocolEthicsCommitteeApprovalNumber)

The method is used to set Clinical Trial Protocol Ethics Committee Approval Number.

Parameters:

strClinicalTrialProtocolEthicsCommitteeApprovalNumber - value Clinical Trial Protocol Ethics Committee Approval Number

getClinicalTrialSponsorName

public java.lang.String getClinicalTrialSponsorName()

Gets the clinical trial sponsor name.

Returns:

the clinical trial sponsor name

getClinicalTrialProtocolName

public java.lang.String getClinicalTrialProtocolName()

Gets the clinical trial protocol name.

Returns:

the clinical trial protocol name

getClinicalTrialProtocolID

public java.lang.String getClinicalTrialProtocolID()

Gets the clinical trial protocol id.

Returns:

the clinical trial protocol id

getClinicalTrialSiteID

public java.lang.String getClinicalTrialSiteID()

Gets the clinical trial site id.

Returns:

the clinical trial site id

getClinicalTrialSiteName

public java.lang.String getClinicalTrialSiteName()

Gets the clinical trial site name.

Returns:

the clinical trial site name

getClinicalTrialSubjectID

public java.lang.String getClinicalTrialSubjectID()

Gets the clinical trial subject id.

Returns:

the clinical trial subject id

getClinicalTrialSubjectReadingID

public java.lang.String getClinicalTrialSubjectReadingID()

Gets the clinical trial subject reading id.

Returns:

the clinical trial subject reading id

getClinicalTrialProtocolEthicsCommitteeName

public java.lang.String getClinicalTrialProtocolEthicsCommitteeName()

Gets the Clinical Trial Protocol Ethics Committee Name.

Returns:

the Clinical Trial Protocol Ethics Committee Name

getClinicalTrialProtocolEthicsCommitteeApprovalNumber

public java.lang.String getClinicalTrialProtocolEthicsCommitteeApprovalNumber()

Gets the Clinical Trial Protocol Ethics Committee Approval Number.

Returns:

the Clinical Trial Protocol Ethics Committee Approval Number

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