cdac.medinfo.sdk.dcm30_04.services.naction.commons

Class NActionRQ

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.services.dimsecommons.DIMSERequest

cdac.medinfo.sdk.dcm30_04.services.naction.commons.NActionRQ

public class NActionRQ
extends DIMSERequest

This class provides required methods to generate Action Request.

Field Summary

Fields inherited from class cdac.medinfo.sdk.dcm30_04.services.dimsecommons.DIMSERequest

shMsgID

Constructor Summary

Constructors

Constructor and Description
NActionRQ() Instantiates a new NAction RQ.
NActionRQ(DicomMessage objDicomMessage) Instantiates a new NAction RQ when Dicom Message is given by user.

Method Summary

Methods

Modifier and Type	Method and Description
short	getActionTypeID() Retrieves value of ActionTypeID.
static NActionRQ	getDefaultRQ(java.lang.String strSOPUID, java.lang.String strSOPInstanceUID, EnumActionTypeID enumActionTypeID, IDataSet objIDataSet) Generates Default RQ for given SOP class UID and Instance UID.
java.lang.String	getRequestedSOPClassUID() Retrieves Requested SOP Class UID .
java.lang.String	getRequestedSOPInstanceUID() Retrieves the UID of the SOP Instance to be retrieved.
void	setActionTypeID(EnumActionTypeID enumActionTypeID) Sets ActionTypeID .
void	setRequestedSOPClassUID(java.lang.String strRequestedSOPClassUID) Sets Requested SOP Class UID .
void	setRequestedSOPInstanceUID(java.lang.String strRequestedSOPInstanceUID) Sets the UID of the SOP Instance to be retrieved.
boolean	validate() Validates the request for their mandatory attributes only.

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

getCommandDataSetType, getCommandField, getCommandGroupLength, getMessageID, setCommandDataSetType, setCommandField, setCommandGroupLength, setMessageID

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

NActionRQ

public NActionRQ()

Instantiates a new NAction RQ. Creates default Dicom Message for NAction RQ.

NActionRQ

public NActionRQ(DicomMessage objDicomMessage)
          throws java.io.IOException

Instantiates a new NAction RQ when Dicom Message is given by user. Retrieves Command Set and Data Set from the DicomMessage and sets in NAction Request.

Parameters:

objDicomMessage - Object of DicomMessage from which NAction request is initialized.

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

Method Detail

setRequestedSOPClassUID

public void setRequestedSOPClassUID(java.lang.String strRequestedSOPClassUID)

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

Parameters:

strRequestedSOPClassUID - value of Requested SOP Class UID.

getRequestedSOPClassUID

public java.lang.String getRequestedSOPClassUID()

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

Returns:

String - value of Requested SOP Class UID .

setRequestedSOPInstanceUID

public void setRequestedSOPInstanceUID(java.lang.String strRequestedSOPInstanceUID)

Sets the UID of the SOP Instance to be retrieved.

Parameters:

strRequestedSOPInstanceUID - String value of Requested SOP Instance UID.

getRequestedSOPInstanceUID

public java.lang.String getRequestedSOPInstanceUID()

Retrieves the UID of the SOP Instance to be retrieved.

Returns:

String - value of Requested SOP Instance UID.

setActionTypeID

public void setActionTypeID(EnumActionTypeID enumActionTypeID)

Sets ActionTypeID . This parameter specifies the type of to be performed.

Parameters:

enumActionTypeID - enum value of ActionTypeID.

getActionTypeID

public short getActionTypeID()

Retrieves value of ActionTypeID.

Returns:

short - value of ActionTypeID.

getDefaultRQ

public static NActionRQ getDefaultRQ(java.lang.String strSOPUID,
                     java.lang.String strSOPInstanceUID,
                     EnumActionTypeID enumActionTypeID,
                     IDataSet objIDataSet)

Generates Default RQ for given SOP class UID and Instance UID. This method returns null when dataset is null in case of some SOP Class UIDs.

Parameters:

strSOPUID - value of SOP Class UID.

strSOPInstanceUID - value of SOP Instance UID.

IActionTypeID - value of Action Type ID.

objIDataSet - instance of DataSet.

Returns:

objNActionRQ instance of objNActionRQ RQ.

validate

public boolean validate()
                 throws InvalidDICOMMessageException

Validates the request for their mandatory attributes only.

Overrides:

validate in class DIMSERequest

Returns:

true, if validation is successful.

Throws:

InvalidDICOMMessageException - If validation of mandatory fields fails.