/*******************************************************************************
 *  Copyright 2017 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.hl7282.hl7model.messages.patientadministration;

import cdac.medinfo.sdk.hl7282.baselibs.messages.Message;
import cdac.medinfo.sdk.hl7282.baselibs.segments.DB1;
import cdac.medinfo.sdk.hl7282.baselibs.segments.EVN;
import cdac.medinfo.sdk.hl7282.baselibs.segments.OBX;
import cdac.medinfo.sdk.hl7282.baselibs.segments.PD1;
import cdac.medinfo.sdk.hl7282.baselibs.segments.PID;
import cdac.medinfo.sdk.hl7282.baselibs.segments.PV1;
import cdac.medinfo.sdk.hl7282.baselibs.segments.PV2;
import cdac.medinfo.sdk.hl7282.baselibs.segments.SFT;
import cdac.medinfo.sdk.hl7282.baselibs.segments.UAC;
import cdac.medinfo.sdk.hl7282.commoninterface.ISegment;
import cdac.medinfo.sdk.hl7282.commoninterface.ISingleCollection;
import cdac.medinfo.sdk.hl7282.utils.EnumMessageCode;
import cdac.medinfo.sdk.hl7282.utils.EnumMessageStructure;
import cdac.medinfo.sdk.hl7282.utils.EnumSegments;
import cdac.medinfo.sdk.hl7282.utils.EnumTriggerEvent;
import cdac.medinfo.sdk.hl7282.utils.IMap;

/**
 * ADT_A12 - Cancel Transfer (Event A12).
 * This event is sent when an transfer a patient is cancelled, either because of
 * erroneous entry of the event or a decision not to transfer the patient after all.
 * <p>Represents a ADT_A12 message structure (see chapter 3.2.12). This structure contains the 
 * following elements: </p>
 * 0: MSH (Message Header Segment) <b>SINGLE_COMPULSARY</b><br>
 * 1: SFT (Software Segment) <b>MULTIPLE_OPTIONAL</b><br>
 * 2: UAC (User Authentication Credential) <b>SINGLE OPTIONAL</b><br/>
 * 3: EVN (Event Type Segment) <b>SINGLE_COMPULSARY</b><br>
 * 4: PID (Patient Identification Segment) <b>SINGLE_COMPULSARY</b><br>
 * 5: PD1 (Patient Additional Demographic Segment) <b>SINGLE_OPTIONAL</b><br>
 * 6: PV1 (Patient Visit Segment) <b>SINGLE_COMPULSARY</b><br>
 * 7: PV2 (Patient Visit - Additional Information Segment) <b>SINGLE_OPTIONAL</b><br>
 * 8: DB1 (Disability Segment) <b>MULTIPLE_OPTIONAL</b><br>
 * 9: OBX (Observation/Result Segment) <b>MULTIPLE_OPTIONAL</b><br>
 * This class provides mechanism to validate message against HL7 v 2.5 standard.
 * The class provides accessors & mutators for the elements mentioned above.
 * These elements can be easily populated & populated values can be easily retrieved.
 * The class has validate method which validates Message against HL7 v 2.5 standard.
 *
 * <p>Following is the step to create message<br>
 * Before that, respective Message Source and Message Recipient to be set on Message Factory.</p>
 * <p>ADT_A12 objA12 = (ADT_A12)MessageFactory.createInstance().createSendSupportedMessage("ADT", "A12");</p>
 */
public final class ADT_A12 extends Message 
{
	/**
	 *  Constructs the ADT_A12 message.
	 */
	ADT_A12(IMap objMessageMap)
	{
		super(objMessageMap, EnumMessageCode.ADT.getValue(), EnumTriggerEvent.A12.getValue(), EnumMessageStructure.ADT_A12.getValue());
	} 

	/**
	 * Adds Software Segment(SFT) to this message.
	 * @param objSFT Specified Software Segment(SFT)to be added in message.
	 */
	public void addSoftwareSegment(SFT objSFT)
	{
		addSegment(EnumSegments.HL7_SEG_SFT, objSFT);
	}


	/**
	 * Adds collection of Software Segment(SFT) to this message.
	 * @param objSFTSegmentCollection Collection of Software Segments to add in this message
	 */
	@SuppressWarnings("unchecked")
	public void addSoftwareSegment(ISingleCollection<SFT>  objSFTSegmentCollection)
	{
		ISingleCollection<?> objSegmentCollection =  objSFTSegmentCollection;
		addSegment(EnumSegments.HL7_SEG_SFT, (ISingleCollection<ISegment>)objSegmentCollection);
	}

	/**
	 * Retrieves Collection of Software Segments(SFT) present in this message.
	 * @return ISingleCollection<SFT> - Collection of Software Segments(SFT) present in this message.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<SFT> getSoftwareSegments()
	{
		ISingleCollection<?> objSegmentCollection = getSegment(EnumSegments.HL7_SEG_SFT);
		return (ISingleCollection<SFT>)objSegmentCollection;
	}

	/**
	 * Retrieves User Authentication Credential(UAC) segment present in this message
	 * @return UAC - Specified UAC Segment
	 */
	public UAC getUserAuthenticationCredentialSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_UAC);
		if(objSingleCollection != null)
			return (UAC)objSingleCollection.elementAt(0);
		return null;
	}

	/**
	 * Sets value of User Authentication Credential segment for this message,overwrites if already present.
	 * @param objUAC Specified UAC Segment
	 */
	public void setUserAuthenticationCredentialSegment(UAC objUAC)
	{
		setSegment(EnumSegments.HL7_SEG_UAC,objUAC);
	}

	
	/**
	 * Retrieves Event Type(EVN) segment present in this message
	 * @return EVN - EVN Segment
	 */
	public EVN getEventTypeSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_EVN);
		if(objSingleCollection != null)
			return (EVN)objSingleCollection.elementAt(0);
		return null;
	}

	/**
	 * Sets value of Event Type segment for this message,overwrites if already present.
	 * @param objEVN Specified EVN Segment
	 */
	public void setEventTypeSegment(EVN objEVN)
	{
		setSegment(EnumSegments.HL7_SEG_EVN,objEVN);
	}

	/**
	 * Retrieves Patient Identification(PID) segment present in this message.
	 * @return PID - Patient Identification Segment
	 */
	public PID getPatientIdentificationSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_PID);
		if(objSingleCollection != null)
			return (PID)objSingleCollection.elementAt(0);
		return null;
	}
	/**
	 * Sets value of PID segment for this message,overwrites if already present.
	 * @param objPID Specified PID Segment
	 */
	public void setPatientIdentificationSegment(PID objPID)
	{
		setSegment(EnumSegments.HL7_SEG_PID,objPID);
	}

	/**
	 * Retrieves Additinal Demographics segment(PD1) present in this message.
	 * @return PD1 - Additinal Demographics(PD1) Segment.
	 */
	public PD1 getAdditinalDemographicsSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_PD1);
		if(objSingleCollection != null)
			return (PD1)objSingleCollection.elementAt(0);
		return null;
	}

	/**
	 * Sets value of Additinal Demographics segment(PD1) for this message,overwrites if already present.
	 * @param objPD1 Specified Additinal Demographics(PD1) Segment.
	 */
	public void setAdditinalDemographicsSegment(PD1 objPD1)
	{
		setSegment(EnumSegments.HL7_SEG_PD1,objPD1);
	}

	/**
	 * Retrieves Patient Visit(PV1) segment present in this message
	 * @return PV1 - PV1 Segment
	 */
	public PV1 getPatientVisitSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_PV1);
		if(objSingleCollection != null)
			return (PV1)objSingleCollection.elementAt(0);
		return null;
	}

	/**
	 * Sets value of Patient Visit segment for this message,overwrites if already present.
	 * @param objPV1 Specified PV1 Segment
	 */
	public void setPatientVisitSegment(PV1 objPV1)
	{
		setSegment(EnumSegments.HL7_SEG_PV1,objPV1);
	}

	/**
	 * Retrieves Patient Visit Additional Info(PV2) segment present in this message.
	 * @return PV2 - Patient Visit Additional Info(PV2) Segment
	 */
	public PV2 getPatientVisitAdditionalInfoSegment()
	{
		ISingleCollection<ISegment> objSingleCollection = getSegment(EnumSegments.HL7_SEG_PV2);
		if(objSingleCollection != null)
			return (PV2)objSingleCollection.elementAt(0);
		return null;
	}
	/**
	 * Sets value of Patient Visit Additional Info(PV2) segment for this message,overwrites if already present.
	 * @param objPV2 Specified PV2 Segment
	 */
	public void setPatientVisitAdditionalInfoSegment(PV2 objPV2)
	{
		setSegment(EnumSegments.HL7_SEG_PV2,objPV2);
	}

	/**
	 * Adds Disability Information(DB1) to this message.
	 * @param objDB1 Specified Disability Information Segment to be added in message.
	 */
	public void addDisabilityInformationSegment(DB1 objDB1)
	{
		addSegment(EnumSegments.HL7_SEG_DB1, objDB1);
	}

	/**
	 * Adds collection of Disability Information(DB1) to this message.
	 * @param objDB1SegmentCollection Collection of Disability Information(DB1) to add in this message
	 */
	@SuppressWarnings("unchecked")
	public void addDisabilityInformationSegment(ISingleCollection<DB1>  objDB1SegmentCollection)
	{
		ISingleCollection<?> objSegmentCollection =  objDB1SegmentCollection;
		addSegment(EnumSegments.HL7_SEG_DB1, (ISingleCollection<ISegment>)objSegmentCollection);
	}

	/**
	 * Retrieves Collection of Disability Information(DB1) present in this message.
	 * @return ISingleCollection<DB1> - Collection of Disability Information(DB1) present in this message.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<DB1> getDisabilityInformationSegments()
	{
		ISingleCollection<?> objSegmentCollection = getSegment(EnumSegments.HL7_SEG_DB1);
		return (ISingleCollection<DB1>)objSegmentCollection;
	}

	/**
	 * Adds Observation Or Result(OBX) to this message.
	 * @param objOBX Specified Observation Or Result Segment to be added in message.
	 */
	public void addObservationOrResultSegment(OBX objOBX)
	{
		addSegment(EnumSegments.HL7_SEG_OBX, objOBX);
	}

	/**
	 * Adds collection of Observation Or Result(OBX) to this message.
	 * @param objOBXSegmentCollection Collection of Observation Or Result(OBX) to add in this message
	 */
	@SuppressWarnings("unchecked")
	public void addObservationOrResultSegment(ISingleCollection<OBX>  objOBXSegmentCollection)
	{
		ISingleCollection<?> objSegmentCollection =  objOBXSegmentCollection;
		addSegment(EnumSegments.HL7_SEG_OBX, (ISingleCollection<ISegment>)objSegmentCollection);
	}

	/**
	 * Retrieves Collection of Observation Or Result(OBX) present in this message.
	 * @return ISingleCollection<OBX> - Collection of Observation Or Result(OBX) present in this message.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<OBX> getObservationOrResultSegments()
	{
		ISingleCollection<?> objSegmentCollection = getSegment(EnumSegments.HL7_SEG_OBX);
		return (ISingleCollection<OBX>)objSegmentCollection;
	}
}