/protocols/ss7/m3ua/api/src/main/java/org/mobicents/protocols/ss7/m3ua/parameter/AffectedPointCode.java

 1/*
 2 * JBoss, Home of Professional Open Source
 3 * Copyright 2011, Red Hat, Inc. and individual contributors
 4 * by the @authors tag. See the copyright.txt in the distribution for a
 5 * full listing of individual contributors.
 6 *
 7 * This is free software; you can redistribute it and/or modify it
 8 * under the terms of the GNU Lesser General Public License as
 9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22
23package org.mobicents.protocols.ss7.m3ua.parameter;
24
25/**
26 * <p>
27 * The affected point code parameter identifies which point codes are affected,
28 * depending on the message type
29 * </p>
30 * 
31 * @author amit bhayani
32 * 
33 */
34public interface AffectedPointCode extends Parameter {
35
36    /**
37     * <p>
38     * To make it easier to identify multiple point codes, ranges can be used as
39     * well. The mask field is used to identify ranges within the point code.
40     * For example, if the mask contains a value of 2, this would indicate that
41     * the last two digits of the point code are a â&#x20AC;&#x153;wild card.â&#x20AC;?
42     * </p>
43     * 
44     * @return returns the mask
45     */
46    public short[] getMasks();
47
48    /**
49     * returns the affected point code.
50     * 
51     * @return
52     */
53    public int[] getPointCodes();
54
55}