cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class StorageCommitmentModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StorageCommitmentModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class StorageCommitmentModule
extends Module

\* This module describes the attributes in Storage Commitment Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StorageCommitmentModule(IDataSet objIDataSet) Creates Storage Commitment Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
FailedSOPSequence	getFailedSOPSequence() Retrieves pre-initialized object of Referenced SOP Sequence.
ReferencedSOPSequence	getReferencedSOPSequence() Retrieves pre-initialized object of Referenced SOP Sequence.
java.lang.String[]	getRetrieveAETitle() Retrieves Application Entity Title where the Image Storage SOP Instance may be retrieved.
java.lang.String	getStorageMediaFileSetID() Retrieves The user or implementation specific human readable identifier that identifies a Storage Media on which this SOP Instance resides.
java.lang.String	getStorageMediaFileSetUID() Retrieves a Unique ID that identifies a Storage Media on which this SOP Instance resides.
java.lang.String	getTransactionUID() Retrieves a String that Uniquely identifies this Storage Commitment transaction.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setRetrieveAETitle(java.lang.String[] strArrRetrieveAETitle) Sets Application Entity Title where the Image Storage SOP Instance may be retrieved via a network based retrieve service.
void	setStorageMediaFileSetID(java.lang.String strStorageMediaFileSetID) The user or implementation specific human readable identifier that identifies a Storage Media on which this SOP Instance resides.
void	setStorageMediaFileSetUID(java.lang.String strStorageMediaFileSetID) Uniquely identifies a Storage Media on which this SOP Instance resides.
void	setTransactionUID(java.lang.String strTransactionUID) Uniquely identifies this Storage Commitment transaction.
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

StorageCommitmentModule

public StorageCommitmentModule(IDataSet objIDataSet)

Creates Storage Commitment 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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setTransactionUID

public void setTransactionUID(java.lang.String strTransactionUID)

Uniquely identifies this Storage Commitment transaction.

Parameters:

strTransactionUID - String value of Transaction UID.

getTransactionUID

public java.lang.String getTransactionUID()

Retrieves a String that Uniquely identifies this Storage Commitment transaction.

Returns:

String - String value of Transaction UID.

setRetrieveAETitle

public void setRetrieveAETitle(java.lang.String[] strArrRetrieveAETitle)

Sets Application Entity Title where the Image Storage SOP Instance may be retrieved via a network based retrieve service.

Parameters:

strArrRetrieveAETitle - String array of Retrieve AE Title.

getRetrieveAETitle

public java.lang.String[] getRetrieveAETitle()

Retrieves Application Entity Title where the Image Storage SOP Instance may be retrieved.

Returns:

String - String value of Retrieve AE Title.

setStorageMediaFileSetID

public void setStorageMediaFileSetID(java.lang.String strStorageMediaFileSetID)

The user or implementation specific human readable identifier that identifies a Storage Media on which this SOP Instance resides.

Parameters:

strStorageMediaFileSetID - String value of Storage Media File-Set ID.

getStorageMediaFileSetID

public java.lang.String getStorageMediaFileSetID()

Retrieves The user or implementation specific human readable identifier that identifies a Storage Media on which this SOP Instance resides.

Returns:

String - String value of Storage Media File-Set ID.

setStorageMediaFileSetUID

public void setStorageMediaFileSetUID(java.lang.String strStorageMediaFileSetID)

Uniquely identifies a Storage Media on which this SOP Instance resides.

Parameters:

strStorageMediaFileSetID - the str storage media file set id

getStorageMediaFileSetUID

public java.lang.String getStorageMediaFileSetUID()

Retrieves a Unique ID that identifies a Storage Media on which this SOP Instance resides.

Returns:

String - String value of Storage Media File-Set UID.

getReferencedSOPSequence

public ReferencedSOPSequence getReferencedSOPSequence()

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

ReferencedSOPSequence - instance of Referenced SOP Sequence.

getFailedSOPSequence

public FailedSOPSequence getFailedSOPSequence()

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

ReferencedSOPSequence - instance of Referenced SOP 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