cdac.medinfo.sdk.dcm30_04.baselibs

Class ReferencedSOPSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.SOPInstanceReferenceMacroDependentItem

cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedSOPSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class ReferencedSOPSequenceItem
extends SOPInstanceReferenceMacroDependentItem

This item class contains methods to set,get and validate the attributes in Referenced SOP Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
IconImageSequence	getIconImageSequence() Retrieves pre-initialized object of Icon Image 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.
java.lang.String	getInstanceAvailability() Return Instance Availability.
java.lang.String	getRequestedMediaApplicationProfile() Retrieves the Media Application Profile used for this SOP Instance.
java.lang.String[]	getRetrieveAETitle() Retrieves Application Entity Title where the Image Storage SOP Instance may be retrieved
java.lang.String	getRetrieveLocationUID() Retrieves Retrieve Location UID.
java.lang.String	getRetrieveURI() Retrieves Retrieve URI.
java.lang.String	getRetrieveURL() Retrieves URI/URL specifying the location of the referenced instance(s).
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.
void	setInstanceAvailability(EnumInstanceAvailability enumSetupDeviceType) Sets Instance Availability.
void	setRequestedMediaApplicationProfile(java.lang.String strRequestedMediaApplicationProfile) Sets the Media Application Profile used for this SOP Instance.
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	setRetrieveLocationUID(java.lang.String strRetrieveLocationUID) Sets Retrieve Location UID.
void	setRetrieveURI(java.lang.String strRetrieveURI) Sets the Retrieve URI.
void	setRetrieveURL(java.lang.String strRetrieveURL) Sets URI/URL specifying the location of the referenced instance(s).
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.
boolean	validateForModule() Validates all the attributes in ReferencedSOPSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.SOPInstanceReferenceMacroDependentItem

getSOPInstanceReferenceMacro

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

setInstanceAvailability

public void setInstanceAvailability(EnumInstanceAvailability enumSetupDeviceType)

Sets Instance Availability. The availability of the referenced Instance. Defined Terms: 1) ONLINE. 2) NEARLINE. 3) OFFLINE 4) UNAVAILABLE.

Parameters:

enumSetupDeviceType - enum value of Instance Availability.

getInstanceAvailability

public java.lang.String getInstanceAvailability()

Return Instance Availability. The availability of the referenced Instance.

Returns:

String - value of Instance Availability.

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 - value of Retrieve AE Title.

setRetrieveLocationUID

public void setRetrieveLocationUID(java.lang.String strRetrieveLocationUID)

Sets Retrieve Location UID. Unique identifier of the system where the Composite Object(s) maybe retrieved on the network.

Parameters:

strRetrieveLocationUID - String value of Retrieve Location UID.

getRetrieveLocationUID

public java.lang.String getRetrieveLocationUID()

Retrieves Retrieve Location UID. Unique identifier of the system where the Composite Object(s) maybe retrieved on the network.

Returns:

String - value of Retrieve Location UID.

setRetrieveURI

public void setRetrieveURI(java.lang.String strRetrieveURI)

Sets the Retrieve URI.

Parameters:

strRetrieveURI - String value of Retrieve URI.

getRetrieveURI

public java.lang.String getRetrieveURI()

Retrieves Retrieve URI.

Returns:

String - value of Retrieve URI.

setRetrieveURL

public void setRetrieveURL(java.lang.String strRetrieveURL)

Sets URI/URL specifying the location of the referenced instance(s).

Parameters:

strRetrieveURL - String value of Retrieve URL.

getRetrieveURL

public java.lang.String getRetrieveURL()

Retrieves URI/URL specifying the location of the referenced instance(s).

Returns:

String - value of Retrieve URL.

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 - 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 - String value of Storage Media File-Set UID.

getStorageMediaFileSetUID

public java.lang.String getStorageMediaFileSetUID()

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

Returns:

String - value of Storage Media File-Set UID.

setRequestedMediaApplicationProfile

public void setRequestedMediaApplicationProfile(java.lang.String strRequestedMediaApplicationProfile)

Sets the Media Application Profile used for this SOP Instance.

Parameters:

strRequestedMediaApplicationProfile - String value of Media Application Profile

getRequestedMediaApplicationProfile

public java.lang.String getRequestedMediaApplicationProfile()

Retrieves the Media Application Profile used for this SOP Instance.

Returns:

String - value of Media Application Profile

getIconImageSequence

public IconImageSequence getIconImageSequence()

Retrieves pre-initialized object of Icon Image 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:

IconImageSequence - instance of IconImageSequence.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in ReferencedSOPSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class SOPInstanceReferenceMacroDependentItem

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.