/*******************************************************************************
 *  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.patientcare;

import cdac.medinfo.sdk.hl7282.baselibs.messages.Message;
import cdac.medinfo.sdk.hl7282.baselibs.segments.PID;
import cdac.medinfo.sdk.hl7282.baselibs.segments.SFT;
import cdac.medinfo.sdk.hl7282.baselibs.segments.UAC;
import cdac.medinfo.sdk.hl7282.commoninterface.IGroup;
import cdac.medinfo.sdk.hl7282.commoninterface.ISegment;
import cdac.medinfo.sdk.hl7282.commoninterface.ISingleCollection;
import cdac.medinfo.sdk.hl7282.utils.EnumSegments;
import cdac.medinfo.sdk.hl7282.utils.IMap;

/**
 * PPG_PCG - Patient Pathway Message (Goal-Oriented)(Events PCG,CH,CJ).
 * This message is use for Patient Pathway Message.
 * <p>Represents a PPP_PCB message structure (see chapter 12.3.4). 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 Segment) <b>SINGLE_OPTIONAL</b><br>
 * 3: PID (Patient Identification Segment) <b>SINGLE_COMPULSARY</b><br>
 * 4: PATIENT_VISIT (a Group in PPG_PCG message) <b>SINGLE_OPTIONAL</b><br>
 * 5: PATHWAY (a Group in PPG_PCG message) <b>MULTIPLE_COMPULSARY</b><br>
 * This class provides mechanism to validate message against HL7 v 2.8.2 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.8.2 standard.
 */
public abstract class PPG_PCG_Common extends Message 
{
	/**
	 *  Constructs the ADT_A01 message.
	 */
	PPG_PCG_Common(IMap objMessageMap, String strTriggerEvent, String strMessageCode, String strMessageStructure)
	{
		super(objMessageMap, strTriggerEvent, strMessageCode, strMessageStructure);
	}
	
	/**
	 * 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;
	}

	/**
	 * Adds Software Segment(SFT) to this message.
	 * @param objSFT Specified Software Segment(SFT) to be added in this messageto this 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 User Authentication Credential(UAC) segment present in this message
	 * @return UAC - the User Authentication Credential Segment present in this message or null if unavailable. 
	 */
	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(UAC) 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 Patient Identification(PID) segment present in this message.
	 * @return PID - the Patient Identification Segment present in this message or null if unavailable.
	 */
	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 Patient Visit Group present in this message.
	 * @return Group - PatientVisit Group present in this message.
	 */
	public IGroup getPatientVisitGroup()
	{
		ISingleCollection<IGroup> objSingleCollection = getGroup(EnumSegments.HL7_GROUP_PATIENT_VISIT);
		if(objSingleCollection != null)
			return objSingleCollection.elementAt(0);
		return null;
	}

	/**
	 * Sets value of Patient Visit Group for this message,overwrites if already present.
	 * @param objGroup Specified PatientVisit Group 
	 */
	public void setPatientVisitGroup(IGroup objGroup)
	{
		setGroup(EnumSegments.HL7_GROUP_PATIENT_VISIT, objGroup);
	}

	/**
	 * Retrieves Collection of PATHWAY GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of PATHWAY  Group present in this Message.
	 */
	public ISingleCollection<IGroup> getPathwayGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_PATHWAY );
	}

	/**
	 * Adds Collection of PATHWAY GROUP to this message.
	 * @param objSingleCollection Specified  PATHWAY  GROUP Collection.
	 */
	public void addPathwayGroups(ISingleCollection<IGroup> objSingleCollection)
	{
		addGroup(EnumSegments.HL7_GROUP_PATHWAY, objSingleCollection);
	}

	/**
	 * Adds PATHWAY GROUP to this message.
	 * @param objGroup Specified PATHWAY GROUP. 
	 */
	public void addPathwayGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_PATHWAY , objGroup);
	}
}
