cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class MediaCreationManagementModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MediaCreationManagementModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class MediaCreationManagementModule
extends Module

\* This module specifies the Attributes used for Media Creation Management.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MediaCreationManagementModule(IDataSet objIDataSet) Instantiates a new media creation management module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAllowLossyCompression() Retrieves A flag indicating if the SCP is allowed to perform lossy compression.
java.lang.String	getAllowMediaSplitting() Retrieves A flag indicating if the SCP is allowed to split this request over more than one piece of media.
java.lang.String	getBarcodeSymbology() Return Code string that describes the bar code symbology that shall be used for printing the Barcode Value.
java.lang.String	getBarcodeValue() Return String that describes the bar code value to be printed on the media label.
java.lang.String	getExecutionStatus() Retrieves Execution status of a request.
java.lang.String	getExecutionStatusInfo() Retrieves Additional information about Execution Status.
FailedSOPSequence	getFailedSOPSequence() Retrieves pre-initialized object of FailedSOPSequence.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
java.lang.String	getIncludeDisplayApplication() Retrieves A flag indicating if the SCP should include on the media a DICOM Instance Display Application.
java.lang.String	getIncludeNonDICOMObjects() Retrieves A flag indicating if the SCP should include in the media additional Non-DICOM information/objects.
java.lang.String	getLabelStyleSelection() Return Unformatted free text to include in the label instead of or in addition to information extracted from the instances.
java.lang.String	getLabelText() Return Unformatted free text to include in the label instead of or in addition to information extracted from the instances.
java.lang.String	getLabelUsingInformationExtractedFromInstances() Retrieves the Specification whether or not to extract label information from the instances.
java.lang.String	getMediaDisposition() Return Unstructured text that describes where and to whom the media is to be sent.
java.lang.String	getNumberOfCopies() Return number of copies to be printed for each film of the film session.
java.lang.String	getPreserveCompositeInstancesAfterMediaCreation() Retrieves A flag indicating if the SCP should include on the media a DICOM Instance Display Application.
ReferencedSOPSequence	getReferencedSOPSequence() Retrieves pre-initialized object of ReferencedSOPSequence.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
ReferencedStorageMediaSequence	getReferencedStorageMediaSequence() Retrieves pre-initialized object of ReferencedStorageMediaSequence.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
java.lang.String	getRequestPriority() Retrieves the priority of the request.
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.
short	getTotalNumberofPiecesofMediaCreated() Retrieves Number of pieces of media that have been successfully created, in order to store all copies of the requested file-set.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAllowLossyCompression(EnumAllowLossyCompression enumAllowLossyCompression) Sets A flag indicating if the SCP is allowed to perform lossy compression.
void	setAllowMediaSplitting(EnumAllowMediaSplitting enumAllowMediaSplitting) Sets A flag indicating if the SCP is allowed to split this request over more than one piece of media.
void	setBarcodeSymbology(java.lang.String strBarcodeSymbology) Sets Code string that describes the bar code symbology that shall be used for printing the Barcode Value.
void	setBarcodeValue(java.lang.String strBarcodeValue) Sets String that describes the bar code value to be printed on the media label.
void	setExecutionStatus(EnumExecutionStatus enumExecutionStatus) Sets Execution status of a request.
void	setExecutionStatusInfo(EnumExecutionStatusInfo enumExecutionStatusInfo) Sets Additional information about Execution Status.
void	setIncludeDisplayApplication(EnumIncludeDisplayApplication enumIncludeDisplayApplication) Sets A flag indicating if the SCP should include on the media a DICOM Instance Display Application.
void	setIncludeNonDICOMObjects(EnumIncludeNonDICOMObjects enumIncludeNonDICOMObjects) Sets A flag indicating if the SCP should include in the media additional Non-DICOM information/objects.
void	setLabelStyleSelection(java.lang.String strLabelStyleSelection) Sets Unformatted free text to include in the label instead of or in addition to information extracted from the instances.
void	setLabelText(java.lang.String strLabelText) Sets Unformatted free text to include in the label instead of or in addition to information extracted from the instances.
void	setLabelUsingInformationExtractedFromInstances(EnumLabelUsingInformationExtractedFromInstances enumLabelUsingInformationExtractedFromInstances) Sets the Specification whether or not to extract label information from the instances.
void	setMediaDisposition(java.lang.String strMediaDisposition) Sets Unstructured text that describes where and to whom the media is to be sent.
void	setNumberOfCopies(java.lang.String strNumberOfCopies) Sets number of copies to be printed for each film of the film session.
void	setPreserveCompositeInstancesAfterMediaCreation(EnumPreserveCompositeInstancesAfterMediaCreation enumPreserveCompositeInstancesAfterMediaCreation) Sets A flag indicating if the SCP should include on the media a DICOM Instance Display Application.
void	setRequestPriority(EnumRequestPriority enumRequestPriority) Sets the priority of the request.
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	setTotalNumberofPiecesofMediaCreated(short shTotalNumberofPiecesofMediaCreated) Sets Number of pieces of media that have been successfully created, in order to store all copies of the requested file-set.
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

MediaCreationManagementModule

public MediaCreationManagementModule(IDataSet objIDataSet)

Instantiates a new media creation management 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

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.

setNumberOfCopies

public void setNumberOfCopies(java.lang.String strNumberOfCopies)

Sets number of copies to be printed for each film of the film session.

Parameters:

strNumberOfCopies - String value of Number Of Copies.

getNumberOfCopies

public java.lang.String getNumberOfCopies()

Return number of copies to be printed for each film of the film session.

Returns:

String - String value of Number Of Copies.

setRequestPriority

public void setRequestPriority(EnumRequestPriority enumRequestPriority)

Sets the priority of the request.

Parameters:

enumRequestPriority - Enum value of RequestPriority.

getRequestPriority

public java.lang.String getRequestPriority()

Retrieves the priority of the request.

Returns:

String - String value of RequestPriority.

setLabelUsingInformationExtractedFromInstances

public void setLabelUsingInformationExtractedFromInstances(EnumLabelUsingInformationExtractedFromInstances enumLabelUsingInformationExtractedFromInstances)

Sets the Specification whether or not to extract label information from the instances.

Parameters:

enumLabelUsingInformationExtractedFromInstances - Enum value of Specification.

getLabelUsingInformationExtractedFromInstances

public java.lang.String getLabelUsingInformationExtractedFromInstances()

Retrieves the Specification whether or not to extract label information from the instances.

Returns:

String - String value of Specification.

setLabelText

public void setLabelText(java.lang.String strLabelText)

Sets Unformatted free text to include in the label instead of or in addition to information extracted from the instances.

Parameters:

strLabelText - String value of LabelText.

getLabelText

public java.lang.String getLabelText()

Return Unformatted free text to include in the label instead of or in addition to information extracted from the instances.

Returns:

String - String value of LabelText.

setLabelStyleSelection

public void setLabelStyleSelection(java.lang.String strLabelStyleSelection)

Sets Unformatted free text to include in the label instead of or in addition to information extracted from the instances.

Parameters:

strLabelStyleSelection - String value of Unformatted free text.

getLabelStyleSelection

public java.lang.String getLabelStyleSelection()

Return Unformatted free text to include in the label instead of or in addition to information extracted from the instances.

Returns:

String - String value of Unformatted free text.

setMediaDisposition

public void setMediaDisposition(java.lang.String strMediaDisposition)

Sets Unstructured text that describes where and to whom the media is to be sent.

Parameters:

strMediaDisposition - String value of Unstructured text.

getMediaDisposition

public java.lang.String getMediaDisposition()

Return Unstructured text that describes where and to whom the media is to be sent.

Returns:

String - String value of Unstructured text.

setBarcodeValue

public void setBarcodeValue(java.lang.String strBarcodeValue)

Sets String that describes the bar code value to be printed on the media label.

Parameters:

strBarcodeValue - String Barcode Value.

getBarcodeValue

public java.lang.String getBarcodeValue()

Return String that describes the bar code value to be printed on the media label.

Returns:

String - String Barcode Value.

setBarcodeSymbology

public void setBarcodeSymbology(java.lang.String strBarcodeSymbology)

Sets Code string that describes the bar code symbology that shall be used for printing the Barcode Value.

Parameters:

strBarcodeSymbology - String bar code symbology.

getBarcodeSymbology

public java.lang.String getBarcodeSymbology()

Return Code string that describes the bar code symbology that shall be used for printing the Barcode Value.

Returns:

String - String bar code symbology.

setAllowMediaSplitting

public void setAllowMediaSplitting(EnumAllowMediaSplitting enumAllowMediaSplitting)

Sets A flag indicating if the SCP is allowed to split this request over more than one piece of media.

Parameters:

enumAllowMediaSplitting - Enum value of flag.

getAllowMediaSplitting

public java.lang.String getAllowMediaSplitting()

Retrieves A flag indicating if the SCP is allowed to split this request over more than one piece of media.

Returns:

String - String value of flag.

setAllowLossyCompression

public void setAllowLossyCompression(EnumAllowLossyCompression enumAllowLossyCompression)

Sets A flag indicating if the SCP is allowed to perform lossy compression.

Parameters:

enumAllowLossyCompression - Enum value of flag.

getAllowLossyCompression

public java.lang.String getAllowLossyCompression()

Retrieves A flag indicating if the SCP is allowed to perform lossy compression.

Returns:

String - String value of flag.

setIncludeNonDICOMObjects

public void setIncludeNonDICOMObjects(EnumIncludeNonDICOMObjects enumIncludeNonDICOMObjects)

Sets A flag indicating if the SCP should include in the media additional Non-DICOM information/objects.

Parameters:

enumIncludeNonDICOMObjects - Enum value of flag.

getIncludeNonDICOMObjects

public java.lang.String getIncludeNonDICOMObjects()

Retrieves A flag indicating if the SCP should include in the media additional Non-DICOM information/objects.

Returns:

String - String value of flag.

setIncludeDisplayApplication

public void setIncludeDisplayApplication(EnumIncludeDisplayApplication enumIncludeDisplayApplication)

Sets A flag indicating if the SCP should include on the media a DICOM Instance Display Application.

Parameters:

enumIncludeDisplayApplication - Enum value of flag.

getIncludeDisplayApplication

public java.lang.String getIncludeDisplayApplication()

Retrieves A flag indicating if the SCP should include on the media a DICOM Instance Display Application.

Returns:

String - String value of flag.

setPreserveCompositeInstancesAfterMediaCreation

public void setPreserveCompositeInstancesAfterMediaCreation(EnumPreserveCompositeInstancesAfterMediaCreation enumPreserveCompositeInstancesAfterMediaCreation)

Sets A flag indicating if the SCP should include on the media a DICOM Instance Display Application.

Parameters:

enumPreserveCompositeInstancesAfterMediaCreation - Enum value of flag.

getPreserveCompositeInstancesAfterMediaCreation

public java.lang.String getPreserveCompositeInstancesAfterMediaCreation()

Retrieves A flag indicating if the SCP should include on the media a DICOM Instance Display Application.

Returns:

String - String value of flag.

setExecutionStatus

public void setExecutionStatus(EnumExecutionStatus enumExecutionStatus)

Sets Execution status of a request.

Parameters:

enumExecutionStatus - Enum value of Execution status.

getExecutionStatus

public java.lang.String getExecutionStatus()

Retrieves Execution status of a request.

Returns:

String - String value of Execution status

setExecutionStatusInfo

public void setExecutionStatusInfo(EnumExecutionStatusInfo enumExecutionStatusInfo)

Sets Additional information about Execution Status.

Parameters:

enumExecutionStatusInfo - Enum value of Additional information

getExecutionStatusInfo

public java.lang.String getExecutionStatusInfo()

Retrieves Additional information about Execution Status.

Returns:

String - String value of Additional information

setTotalNumberofPiecesofMediaCreated

public void setTotalNumberofPiecesofMediaCreated(short shTotalNumberofPiecesofMediaCreated)

Sets Number of pieces of media that have been successfully created, in order to store all copies of the requested file-set.

Parameters:

shTotalNumberofPiecesofMediaCreated - short value of Number of pieces

getTotalNumberofPiecesofMediaCreated

public short getTotalNumberofPiecesofMediaCreated()

Retrieves Number of pieces of media that have been successfully created, in order to store all copies of the requested file-set.

Returns:

short - short value of Number of pieces

getReferencedSOPSequence

public ReferencedSOPSequence getReferencedSOPSequence()

Retrieves pre-initialized object of ReferencedSOPSequence.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 ReferencedSOPSequence.

getFailedSOPSequence

public FailedSOPSequence getFailedSOPSequence()

Retrieves pre-initialized object of FailedSOPSequence.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:

FailedSOPSequence - instance of FailedSOPSequence.

getReferencedStorageMediaSequence

public ReferencedStorageMediaSequence getReferencedStorageMediaSequence()

Retrieves pre-initialized object of ReferencedStorageMediaSequence.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:

ReferencedStorageMediaSequence - instance of ReferencedStorageMediaSequence.

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