cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ApprovalModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ApprovalModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ApprovalModule
extends Module

\* This module describes attributes in Approval Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ApprovalModule(IDataSet objIDataSet) Instantiates a new approval module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getApprovalStatus() Retrieves Approval status at the time the SOP Instance was created.
java.lang.String	getReviewDate() Retrieves date on which object was reviewed.
java.lang.String	getReviewerName() Retrieves Name of person who reviewed object.
java.lang.String	getReviewTime() Retrieves time at which object was reviewed.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setApprovalStatus(EnumApprovalStatus enumApprovalStatus) Sets Approval status at the time the SOP Instance was created.
void	setReviewDate(java.lang.String strReviewDate) Sets date on which object was reviewed.
void	setReviewerName(java.lang.String strReviewerName) Sets Name of person who reviewed object.
void	setReviewTime(java.lang.String strReviewTime) Sets time at which object was reviewed.
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

ApprovalModule

public ApprovalModule(IDataSet objIDataSet)

Instantiates a new approval 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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setApprovalStatus

public void setApprovalStatus(EnumApprovalStatus enumApprovalStatus)

Sets Approval status at the time the SOP Instance was created. Enumerated Values: 1) APPROVED = Reviewer recorded that object met an implied criterion. 2) UNAPPROVED = No review of object has been recorded. 3) REJECTED = Reviewer recorded that object failed to meet an implied criterion.

Parameters:

enumApprovalStatus - the enum approval status

getApprovalStatus

public java.lang.String getApprovalStatus()

Retrieves Approval status at the time the SOP Instance was created.

Returns:

String - String value of Approval status.

setReviewDate

public void setReviewDate(java.lang.String strReviewDate)

Sets date on which object was reviewed. Required if Approval Status (300E,0002) is APPROVED or REJECTED.

Parameters:

strReviewDate - String value of Review Date.

getReviewDate

public java.lang.String getReviewDate()

Retrieves date on which object was reviewed. Required if Approval Status (300E,0002) is APPROVED or REJECTED.

Returns:

the review date

setReviewTime

public void setReviewTime(java.lang.String strReviewTime)

Sets time at which object was reviewed. Required if Approval Status (300E,0002) is APPROVED or REJECTED.

Parameters:

strReviewTime - String value of Review Time.

getReviewTime

public java.lang.String getReviewTime()

Retrieves time at which object was reviewed.

Returns:

the review time

setReviewerName

public void setReviewerName(java.lang.String strReviewerName)

Sets Name of person who reviewed object. Required if Approval Status (300E,0002) is APPROVED or REJECTED.

Parameters:

strReviewerName - String value of Reviewer Name.

getReviewerName

public java.lang.String getReviewerName()

Retrieves Name of person who reviewed object.

Returns:

the reviewer name

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