/*******************************************************************************
 *  Copyright 2017-2018 Centre for Development of Advanced Computing(C-DAC), Pune
 *  
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *  
 *   http://www.apache.org/licenses/LICENSE-2.0
 *  
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package cdac.medinfo.sdk.dcm30_04.baselibs;


import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataElement;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;




/**
* This item class contains the methods to set, get and validate the attribute present in Referenced General Purpose Scheduled Procedure Step Sequence Item
 */
public class ReferencedGeneralPurposeScheduledProcedureStepSequenceItem extends Item  
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	ReferencedGeneralPurposeScheduledProcedureStepSequenceItem()
	{
		super();
	}

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	ReferencedGeneralPurposeScheduledProcedureStepSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates Annotation Content Sequence Item with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	ReferencedGeneralPurposeScheduledProcedureStepSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Validates all the attributes in {@link ReferencedGeneralPurposeScheduledProcedureStepSequenceItem} that are present in the DataSet.
	 * @return boolean - Success -true, Failure - false.
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		return true;
	}

	/**
	 * Sets attribute identifies Uniquely identifies the SOP Class.
	 * @param StrReferencedSOPClassUID String identifies SOP Class.
	 */	
	public void setReferencedSOPClassUID(String StrReferencedSOPClassUID)
	{
		/*Accept ReferencedSOPClassUID in String format of type CS.
		 * Read the Transfer Syntax and check to create ImplicitDE or ExplicitDE .
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Hash Map
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0008,0x1150,StrReferencedSOPClassUID,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0008,0x1150, DicomConstants.DCM_DT_UI,StrReferencedSOPClassUID);
		addDataElement(objIDataElement);
	}

	/**
	 * Return Uniquely identifies the SOP Class.
	 * @return String - identifies the SOP Class.
	 */
	public String getReferencedSOPClassUID()
	{
		Object objValue = getValue(0x0008,0x1150);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets attribute Uniquely identifies the SOP Instance.
	 * @param StrReferencedSOPInstanceUID String identifies the SOP Instance.
	 */	
	public void setReferencedSOPInstanceUID(String StrReferencedSOPInstanceUID)
	{
		/*Accept ReferencedSOPInstanceUID in String format of type CS.
		 * Read the Transfer Syntax and check to create ImplicitDE or ExplicitDE .
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Hash Map
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0008,0x1155,StrReferencedSOPInstanceUID,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0008,0x1155, DicomConstants.DCM_DT_UI,StrReferencedSOPInstanceUID);
		addDataElement(objIDataElement);
	}

	/**attribute Uniquely identifies the SOP Instance.Referenced SOP Class UID
	 * @return String - identifies the SOP Instance.
	 */
	public String getReferencedSOPInstanceUID()
	{
		Object objValue = getValue(0x0008,0x1155);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets attribute Transaction UID (0008,1195) used in the N-ACTION transaction that requested the transition to the IN
	 * PROGRESS state for the referenced General Purpose Scheduled Procedure Step.
	 * @param StrReferencedGeneralPurposeScheduledProcedureStepTransactionUID String identifies the referenced SOP Class.
	 */	
	public void setReferencedGeneralPurposeScheduledProcedureStepTransactionUID(String StrReferencedGeneralPurposeScheduledProcedureStepTransactionUID)
	{
		/*Accept ReferencedGeneralPurposeScheduledProcedureStepTransactionUID in String Array format of type CS.
		 * Read the Transfer Syntax and check to create ImplicitDE or ExplicitDE .
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Hash Map
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0040,0x4023,StrReferencedGeneralPurposeScheduledProcedureStepTransactionUID,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0040,0x4023, DicomConstants.DCM_DT_UI,StrReferencedGeneralPurposeScheduledProcedureStepTransactionUID);
		addDataElement(objIDataElement);
	}

	/**
	 * Return attribute Transaction UID (0008,1195) used in the N-ACTION transaction that requested the transition to the IN
	 * PROGRESS state for the referenced General Purpose Scheduled Procedure Step.
	 * @return String - identifies the referenced SOP Class.
	 */
	public String getReferencedGeneralPurposeScheduledProcedureStepTransactionUID()
	{
		Object objValue = getValue(0x0040,0x4023);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
