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

import cdac.medinfo.sdk.hl7282.baselibs.messages.Message;
import cdac.medinfo.sdk.hl7282.baselibs.segments.EVN;
import cdac.medinfo.sdk.hl7282.baselibs.segments.NK1;
import cdac.medinfo.sdk.hl7282.baselibs.segments.PD1;
import cdac.medinfo.sdk.hl7282.baselibs.segments.PID;
import cdac.medinfo.sdk.hl7282.baselibs.segments.REL;
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.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;

/**
 * CCM_I21-Collaborative Care Message (Event I21).
 * This event triggers a message to be sent from one healthcare provider to another healthcare provider, 
 * clinical repository or regulatory body regarding a specific patient.
 * <p>Represents a CCM_I21 message structure (see chapter 11.6.1). 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: PID (Patient Identification Segment) <b>SINGLE_COMPULSARY</b><br>
 * 4: PD1 (Patient Additional Demographic Segment) <b>SINGLE_OPTIONAL</b><br>
 * 5: NK1 (Next of Kin / Associated Parties Segment) <b>MULTIPLE_OPTIONAL</b><br>
 * 6: INSURANCE (a Group of segments in CCM_I21 message) <b>MULTIPLE_OPTIONAL</b><br>
 * 7: APPOINTMENT HISTORY (a Group of segments in CCM_I21 message) <b>MULTIPLE_OPTIONAL</b><br>
 * 8: CLINICAL HISTORY (a Group of segments in CCM_I21 message) <b>MULTIPLE_OPTIONAL</b><br>
 * 9: PATIENT_VISIT (a Group in CCM_I21 message) <b>MULTIPLE_COMPULSARY</b><br>
 * 10: MEDICATION HISTORY (a Group of segments in CCM_I21 message) <b>MULTIPLE_OPTIONAL</b><br>
 * 11: PROBLEM (a Group of segments in CCM_I21 message) <b>MULTIPLE_OPTIONAL</b><br>
 * 12: GOAL (a Group of segments in CCM_I21 message) <b>MULTIPLE_OPTIONAL</b><br>
 * 13: PATHWAY (a Group of segments in CCM_I21 message) <b>MULTIPLE_OPTIONAL</b><br>
 * 14: REL (Relationship) <b>MULTIPLE_OPTIONAL</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 final class CCM_I21 extends Message{

	/**
	 * Constructs the CCM_I21 message.
	 */
	public CCM_I21(IMap objMessageMap) {
		super(objMessageMap, EnumMessageCode.CCM.getValue(), EnumTriggerEvent.I21.getValue(), EnumMessageStructure.CCM_I21.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 - Specified 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 - Specified 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 - Specified 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);
	}
	
	/**
	 * Adds Next of Kin/Associated Parties Segment(NK1) to this message.
	 * @param objNK1 Specified Next of Kin/Associated Parties Segment(NK1) to add in message.
	 */
	public void addNextOfKinOrAssociatedPartiesSegment(NK1 objNK1)
	{
		addSegment(EnumSegments.HL7_SEG_NK1, objNK1);
	}

	/**
	 * Adds collection of Next of Kin Segments(NK1) to this message.
	 * @param objNK1SegmentCollection Collection of Next of Kin/Associated Parties Segment(NK1) to add in this message
	 */
	@SuppressWarnings("unchecked")
	public void addNextOfKinOrAssociatedPartiesSegment(ISingleCollection<NK1>  objNK1SegmentCollection)
	{
		ISingleCollection<?> objSegmentCollection =  objNK1SegmentCollection;
		addSegment(EnumSegments.HL7_SEG_NK1, (ISingleCollection<ISegment>)objSegmentCollection);
	}

	/**
	 * Retrieves Collection of Next of Kin/Associated Parties Segment(NK1) present in this message.
	 * @return ISingleCollection<NK1> - Collection of Next of Kin/Associated Parties Segment(NK1) present in this message.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<NK1> getNextOfKinOrAssociatedPartiesSegments()
	{
		ISingleCollection<?> objSegmentCollection = getSegment(EnumSegments.HL7_SEG_NK1);
		return (ISingleCollection<NK1>)objSegmentCollection;
	}
	
	/**
	 * Retrieves Collection of Insurance GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of Insurance Group present 
	 */
	public ISingleCollection<IGroup> getInsuranceGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_INSURANCE);
	}

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

	/**
	 * Adds Insurance GROUP to this message.
	 * @param objGroup Specified Insurance GROUP. 
	 */
	public void addInsuranceGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_INSURANCE, objGroup);
	}
	
	/**
	 * Retrieves Collection of Appointment History GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of Appointment History Group present 
	 */
	public ISingleCollection<IGroup> getAppointmentHistoryGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_APPOINTMENT_HISTORY);
	}

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

	/**
	 * Adds Appointment History GROUP to this message.
	 * @param objGroup Specified Appointment History GROUP. 
	 */
	public void addAppointmentHistoryGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_APPOINTMENT_HISTORY, objGroup);
	}
	
	/**
	 * Retrieves Collection of Clinical History GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of Clinical History Group present 
	 */
	public ISingleCollection<IGroup> getClinicalHistoryGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_CLINICAL_HISTORY);
	}

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

	/**
	 * Adds Clinical History GROUP to this message.
	 * @param objGroup Specified Clinical History GROUP. 
	 */
	public void addClinicalHistoryGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_CLINICAL_HISTORY, objGroup);
	}
	
	/**
	 * Retrieves Collection of Patient Visit GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of Patient Visit Group present 
	 */
	public ISingleCollection<IGroup> getPatientVisitGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_PATIENT_VISIT);
	}

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

	/**
	 * Adds Patient Visit GROUP to this message.
	 * @param objGroup Patient Visit GROUP. 
	 */
	public void addPatientVisitGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_PATIENT_VISIT, objGroup);
	}
	
	/**
	 * Retrieves Collection of Medication History GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of Medication History Group present 
	 */
	public ISingleCollection<IGroup> getMedicationHistoryGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_MEDICATION_HISTORY);
	}

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

	/**
	 * Adds Medication History GROUP to this message.
	 * @param objGroup Specified Medicationl History GROUP. 
	 */
	public void addMedicationHistoryGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_MEDICATION_HISTORY, objGroup);
	}
	
	/**
	 * Retrieves Collection of Problem GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of Problem Group present 
	 */
	public ISingleCollection<IGroup> getProblemGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_PROBLEM);
	}

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

	/**
	 * Adds Problem GROUP to this message.
	 * @param objGroup Specified Problem GROUP. 
	 */
	public void addProblemGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_PROBLEM, objGroup);
	}
	
	/**
	 * Retrieves Collection of Goal GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of Goal Group present 
	 */
	public ISingleCollection<IGroup> getGoalGroups()
	{
		return getGroup(EnumSegments.HL7_GROUP_GOAL);
	}

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

	/**
	 * Adds Goal GROUP to this message.
	 * @param objGroup Specified Goal GROUP. 
	 */
	public void addGoalGroup(IGroup objGroup)
	{
		addGroup(EnumSegments.HL7_GROUP_GOAL, objGroup);
	}
	
	/**
	 * Retrieves Collection of Pathway GROUP present in this message.
	 * @return ISingleCollection<Group> - Collection of Pathway Group present 
	 */
	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);
	}
	
	/**
	 * Adds Relationship Segment(REL) to this message.
	 * @param objREL Specified Relationship Segment(REL)to be added in message.
	 */
	public void addRelationshipSegment(REL objREL)
	{
		addSegment(EnumSegments.HL7_SEG_REL, objREL);
	}


	/**
	 * Adds collection of Relationship Segment(REL) to this message.
	 * @param objRELSegmentCollection Collection of Relationship Segments to add in this message
	 */
	@SuppressWarnings("unchecked")
	public void addRelationshipSegment(ISingleCollection<REL>  objRELSegmentCollection)
	{
		ISingleCollection<?> objSegmentCollection =  objRELSegmentCollection;
		addSegment(EnumSegments.HL7_SEG_REL, (ISingleCollection<ISegment>)objSegmentCollection);
	}
	
	/**
	 * Retrieves Collection of Relationship Segments(REL) present in this message.
	 * @return ISingleCollection<REL> - Collection of Relationship Segments(REL) present in this message.
	 */
	@SuppressWarnings("unchecked")
	public ISingleCollection<REL> getRelationshipSegments()
	{
		ISingleCollection<?> objSegmentCollection = getSegment(EnumSegments.HL7_SEG_REL);
		return (ISingleCollection<REL>)objSegmentCollection;
	}
}
