cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PrintJobModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PrintJobModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PrintJobModule
extends Module

\* This module specifies the Attributes that identify the print Job.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PrintJobModule(IDataSet objIDataSet) Instantiates a new prints the job module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCreationDate() Retrieves Date of print job creation.
java.lang.String	getCreationTime() Retrieves Date of print job creation.
java.lang.String	getExecutionStatus() Retrieves execution status of print job.
java.lang.String	getExecutionStatusInfo() Retrieves dditional information about Execution Status (2100,0020).
java.lang.String	getOriginator() Retrieves User defined name identifying the printer.
java.lang.String	getPrinterName() Retrieves User defined name identifying the printer.
java.lang.String	getPrintPriority() Return the priority of the print job.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setCreationDate(java.lang.String strCreationDate) Sets Date of print job creation.
void	setCreationTime(java.lang.String strCreationTime) Sets Time of print job creation.
void	setExecutionStatus(EnumExecutionStatus enumExecutionStatus) Sets Execution status of print job.
void	setExecutionStatusInfo(EnumExecutionStatusInfo enumExecutionStatusInfo) Sets Additional information about Execution Status (2100,0020).
void	setOriginator(java.lang.String strOriginator) Sets DICOM Application Entity Title that issued the print operation.
void	setPrinterName(java.lang.String strPrinterName) Sets User defined name identifying the printer.
void	setPrintPriority(EnumPrintPriority enumPrintPriority) Sets the priority of the print job.
boolean	validateModule() Validates each Attribute in the Module according to the Type of the Attribute.

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

PrintJobModule

public PrintJobModule(IDataSet objIDataSet)

Instantiates a new prints the job module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

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

setExecutionStatus

public void setExecutionStatus(EnumExecutionStatus enumExecutionStatus)

Sets Execution status of print job. Enumerated Values: PENDING,PRINTING,DONE,FAILURE.

Parameters:

enumExecutionStatus - Enum value of Execution status of print job.

getExecutionStatus

public java.lang.String getExecutionStatus()

Retrieves execution status of print job.

Returns:

String - String value of Execution Status.

setExecutionStatusInfo

public void setExecutionStatusInfo(EnumExecutionStatusInfo enumExecutionStatusInfo)

Sets Additional information about Execution Status (2100,0020). Defined Terms when the Execution Status is DONE or PRINTING : NORMAL. Defined Terms when the Execution Status is FAILURE: INVALID PAGE DES = The specified page layout cannot be printed or other page description errors have been detected. INSUFFIC MEMORY = There is not enough memory available to complete this job.

Parameters:

enumExecutionStatusInfo - Enum value of Execution status Info.

getExecutionStatusInfo

public java.lang.String getExecutionStatusInfo()

Retrieves dditional information about Execution Status (2100,0020).

Returns:

String - String value of Execution Status Info.

setCreationDate

public void setCreationDate(java.lang.String strCreationDate)

Sets Date of print job creation.

Parameters:

strCreationDate - String value of Date of print job creation.

getCreationDate

public java.lang.String getCreationDate()

Retrieves Date of print job creation.

Returns:

String - String value of Creation Date.

setCreationTime

public void setCreationTime(java.lang.String strCreationTime)

Sets Time of print job creation.

Parameters:

strCreationTime - String value of Time of print job creation.

getCreationTime

public java.lang.String getCreationTime()

Retrieves Date of print job creation.

Returns:

String - String value of Creation Time.

setPrintPriority

public void setPrintPriority(EnumPrintPriority enumPrintPriority)

Sets the priority of the print job. Enumerated Values: HIGH, MED, LOW.

Parameters:

enumPrintPriority - the enum print priority

getPrintPriority

public java.lang.String getPrintPriority()

Return the priority of the print job.

Returns:

String - String value of Print Priority.

setPrinterName

public void setPrinterName(java.lang.String strPrinterName)

Sets User defined name identifying the printer.

Parameters:

strPrinterName - String value of User defined name identifying the printer.

getPrinterName

public java.lang.String getPrinterName()

Retrieves User defined name identifying the printer.

Returns:

String - String value of User defined name identifying the printer.

setOriginator

public void setOriginator(java.lang.String strOriginator)

Sets DICOM Application Entity Title that issued the print operation.

Parameters:

strOriginator - String value of Originator.

getOriginator

public java.lang.String getOriginator()

Retrieves User defined name identifying the printer.

Returns:

String - String value of User defined name identifying the printer.

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:

Collection of tags - returns the vector containing the collection of tags.