cdac.medinfo.sdk.dcm30_04.services.dimsecommons

Class DIMSEResponse

java.lang.Object

cdac.medinfo.sdk.dcm30_04.services.dimsecommons.DicomMessage

cdac.medinfo.sdk.dcm30_04.services.dimsecommons.DIMSEResponse

Direct Known Subclasses:

CEchoRSP, CFindRSP, CGetRSP, CMoveRSP, CStoreRSP, NActionRSP, NCreateRSP, NDeleteRSP, NEventReportRSP, NGetRSP, NSetRSP

public class DIMSEResponse
extends DicomMessage

The class DIMSE Request specifies common attributes of DIMSERequest for all services.

Constructor Summary

Constructors

Constructor and Description
DIMSEResponse()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAffectedSOPClassUID() Retrieves Affected SOP Class UID .
short	getCommandDataSetType() Retrieves DataSet type.
short	getCommandField() Retrieves Command Field.
int	getCommandGroupLength() Retrieves the Group Length .
java.lang.String	getErrorComment() Retrieves ErrorComment .
short	getMessageIDBeingRespondedTo() Retrieves Message ID Being Responded To.
ISingleCollection<ITag>	getOffendingElement() Retrieves the status of the response.
short	getStatus() Retrieves the status of the Response.
void	setAffectedSOPClassUID(java.lang.String strAffectedSOPClassUID) Sets Affected SOP Class UID .
void	setCommandDataSetType(short shDataSetType) This field indicates that no Data Set is present in the Message and shall be set to a value of 0101H.
void	setCommandField(EnumCommandField enumCommandField) Sets Command Field.
void	setCommandGroupLength(int lCommandGroupLength) Sets Group Length i.e The even number of bytes from the end of the value field to the beginning of the next group
void	setErrorComment(EnumErrorComment enumErrorComment) Sets ErrorComment .
void	setMessageIDBeingRespondedTo(short shMessageIDBeingRespondedTo) Sets Message ID Being Responded To.
void	setOffendingElement(ISingleCollection<ITag> objITagCollection) Sets collection of OffendingElements which does not support Dicom Protocol rules.
void	setStatus(IStatus enumStatus) This Indicates the status of the response.
void	setStatus(short shStatus) This Indicates the status of the response.
boolean	validate() Validates command set for their mandatory attributes which are common in all services response.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.services.dimsecommons.DicomMessage

dispose, getCommandSet, getCommandType, getDataSet, getMaxNegotiationLength, getValue, setCommandSet, setDataSet, setDataSet, setMaxNegotiationLength

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DIMSEResponse

public DIMSEResponse()

Method Detail

setCommandGroupLength

public void setCommandGroupLength(int lCommandGroupLength)

Sets Group Length i.e The even number of bytes from the end of the value field to the beginning of the next group

Parameters:

lGroupLength - value of group length

getCommandGroupLength

public int getCommandGroupLength()

Retrieves the Group Length . The even number of bytes from the end of the value field to the beginning of the next group

Returns:

int - value of Group Length

setAffectedSOPClassUID

public void setAffectedSOPClassUID(java.lang.String strAffectedSOPClassUID)

Sets Affected SOP Class UID . SOP Class UID associated with the operation.

Parameters:

strAffectedSOPClassUID - value of affected SOP Class UID.

getAffectedSOPClassUID

public java.lang.String getAffectedSOPClassUID()

Retrieves Affected SOP Class UID . SOP Class UID associated with the operation.

Returns:

String - value of Affected SOP Class UID .

setCommandField

public void setCommandField(EnumCommandField enumCommandField)

Sets Command Field. This field distinguishes the DIMSE-C operation conveyed by this Message. The value of this field shall be set to 8030H for the C-ECHO-RSP Message.

Parameters:

enumCommandField - the enum command field

getCommandField

public short getCommandField()

Retrieves Command Field.

Returns:

short - value of command field

setCommandDataSetType

public void setCommandDataSetType(short shDataSetType)

This field indicates that no Data Set is present in the Message and shall be set to a value of 0101H.

Parameters:

shDataSetType - value of DataSet type.

getCommandDataSetType

public short getCommandDataSetType()

Retrieves DataSet type.

Returns:

short - value of DataSet type.

setMessageIDBeingRespondedTo

public void setMessageIDBeingRespondedTo(short shMessageIDBeingRespondedTo)

Sets Message ID Being Responded To. Shall be set to the value of the Message ID (0000,0110) field used in associated C-ECHO RQ Message.

Parameters:

shMessageIDBeingRespondedTo - value of Message ID Being Responded To.

getMessageIDBeingRespondedTo

public short getMessageIDBeingRespondedTo()

Retrieves Message ID Being Responded To.

Returns:

short - value of Message ID Being Responded To.

setStatus

public void setStatus(IStatus enumStatus)

This Indicates the status of the response. It shall have a value of Success.

Parameters:

enumStatus - the enum status

setStatus

public void setStatus(short shStatus)

This Indicates the status of the response. It shall have a value of Success.

Parameters:

short - the value of status

getStatus

public short getStatus()

Retrieves the status of the Response.

Returns:

short - value of status.

setOffendingElement

public void setOffendingElement(ISingleCollection<ITag> objITagCollection)

Sets collection of OffendingElements which does not support Dicom Protocol rules.

Parameters:

objITagCollection - collection of OffendingElements

getOffendingElement

public ISingleCollection<ITag> getOffendingElement()

Retrieves the status of the response.

Returns:

short - value of status.

setErrorComment

public void setErrorComment(EnumErrorComment enumErrorComment)

Sets ErrorComment . An application specific text description of the error detected.

Parameters:

enumErrorComment - value of ErrorComment.

getErrorComment

public java.lang.String getErrorComment()

Retrieves ErrorComment . An application specific text description of the error detected.

Returns:

String - value of ErrorComment .

validate

public boolean validate()
                 throws InvalidDICOMMessageException

Validates command set for their mandatory attributes which are common in all services response.

Overrides:

validate in class DicomMessage

Returns:

true, if validation is successful.

Throws:

InvalidDICOMMessageException - If validation of mandatory fields fails.