001/*
002 * This class is an auto-generated source file for a HAPI
003 * HL7 v2.x standard structure class.
004 *
005 * For more information, visit: http://hl7api.sourceforge.net/
006 * 
007 * The contents of this file are subject to the Mozilla Public License Version 1.1 
008 * (the "License"); you may not use this file except in compliance with the License. 
009 * You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
010 * Software distributed under the License is distributed on an "AS IS" basis, 
011 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
012 * specific language governing rights and limitations under the License. 
013 * 
014 * The Original Code is "[file_name]".  Description: 
015 * "[one_line_description]" 
016 * 
017 * The Initial Developer of the Original Code is University Health Network. Copyright (C) 
018 * 2012.  All Rights Reserved. 
019 * 
020 * Contributor(s): ______________________________________. 
021 * 
022 * Alternatively, the contents of this file may be used under the terms of the 
023 * GNU General Public License (the  "GPL"), in which case the provisions of the GPL are 
024 * applicable instead of those above.  If you wish to allow use of your version of this 
025 * file only under the terms of the GPL and not to allow others to use your version 
026 * of this file under the MPL, indicate your decision by deleting  the provisions above 
027 * and replace  them with the notice and other provisions required by the GPL License.  
028 * If you do not delete the provisions above, a recipient may use your version of 
029 * this file under either the MPL or the GPL. 
030 * 
031 */
032
033package ca.uhn.hl7v2.model.v25.datatype;
034
035import ca.uhn.hl7v2.model.DataTypeException;
036import ca.uhn.hl7v2.model.Message;
037import ca.uhn.hl7v2.model.Type;
038import ca.uhn.hl7v2.model.AbstractComposite;
039
040/**
041 * <p>Represents an HL7 MOP (Money or Percentage) data type. 
042 * This type consists of the following components:</p>
043 * <ul>
044 * <li>Money or Percentage Indicator (ID)
045 * <li>Money or Percentage Quantity (NM)
046 * <li>Currency Denomination (ID)
047 * </ul>
048 */
049@SuppressWarnings("unused")
050public class MOP extends AbstractComposite {
051
052    private Type[] data;
053
054    /** 
055     * Creates a new MOP type
056     */
057    public MOP(Message message) {
058        super(message);
059        init();
060    }
061
062    private void init() {
063        data = new Type[3];    
064        data[0] = new ID(getMessage(), 148);
065        data[1] = new NM(getMessage());
066        data[2] = new ID(getMessage(), 0);
067    }
068
069
070    /**
071     * Returns an array containing the data elements.
072     */
073    public Type[] getComponents() { 
074        return this.data; 
075    }
076
077    /**
078     * Returns an individual data component.
079     *
080     * @param number The component number (0-indexed)
081     * @throws DataTypeException if the given element number is out of range.
082     */
083    public Type getComponent(int number) throws DataTypeException { 
084
085        try { 
086            return this.data[number]; 
087        } catch (ArrayIndexOutOfBoundsException e) { 
088            throw new DataTypeException("Element " + number + " doesn't exist (Type " + getClass().getName() + " has only " + this.data.length + " components)"); 
089        } 
090    } 
091
092
093    /**
094     * Returns Money or Percentage Indicator (component 1).  This is a convenience method that saves you from 
095     * casting and handling an exception.
096     */
097    public ID getMoneyOrPercentageIndicator() {
098       return getTyped(0, ID.class);
099    }
100
101    
102    /**
103     * Returns Money or Percentage Indicator (component 1).  This is a convenience method that saves you from 
104     * casting and handling an exception.
105     */
106    public ID getMop1_MoneyOrPercentageIndicator() {
107       return getTyped(0, ID.class);
108    }
109
110
111    /**
112     * Returns Money or Percentage Quantity (component 2).  This is a convenience method that saves you from 
113     * casting and handling an exception.
114     */
115    public NM getMoneyOrPercentageQuantity() {
116       return getTyped(1, NM.class);
117    }
118
119    
120    /**
121     * Returns Money or Percentage Quantity (component 2).  This is a convenience method that saves you from 
122     * casting and handling an exception.
123     */
124    public NM getMop2_MoneyOrPercentageQuantity() {
125       return getTyped(1, NM.class);
126    }
127
128
129    /**
130     * Returns Currency Denomination (component 3).  This is a convenience method that saves you from 
131     * casting and handling an exception.
132     */
133    public ID getCurrencyDenomination() {
134       return getTyped(2, ID.class);
135    }
136
137    
138    /**
139     * Returns Currency Denomination (component 3).  This is a convenience method that saves you from 
140     * casting and handling an exception.
141     */
142    public ID getMop3_CurrencyDenomination() {
143       return getTyped(2, ID.class);
144    }
145
146
147
148}
149